我如何自定义 Enterprise Architect 生成的文档块?
How do I customize the documentation blocks Enterprise Architect Generates?
我正在使用 Enterprise Architect 为我的软件建模并生成代码框架。作为此过程的一部分,该工具将自动为 classes、函数和数据成员添加文档块。这很好,但我没有看到任何明显的自定义输出的方法。例如,这是 class Foo:
的结果
/**
* Text from the properties window in EA for Foo.
* @author My Name
* @version 1.0
* @created 26-Oct-2017 12:32:57
*/
class Foo
{
我查看了代码模板编辑器,但像这样的事情似乎都隐藏在一个神奇的功能后面。例如,C++ Class Notes 模板包含 %JAVADOC_COMMENT($wrapLen)
,但我还没有看到我可以在哪里对评论中的内容产生任何影响。
有没有办法在 EA 中自定义 JavaDoc 输出?或者定义我自己的 "Comment Style"?例如,也许我想切换项目的显示顺序,我想在参数之间添加一些空行,或者我想从我的文档块中完全删除 @created
。
您提到的魔法函数也是一个documented宏:
JAVADOC_COMMENT([wrap_length])
Converts the notes for the element currently in scope to javadoc -style comments.
因此您将无法调整宏的工作方式。
但是你当然可以用你自己的评论部分替换标准宏,如果你真的认为那是值得的话。
我正在使用 Enterprise Architect 为我的软件建模并生成代码框架。作为此过程的一部分,该工具将自动为 classes、函数和数据成员添加文档块。这很好,但我没有看到任何明显的自定义输出的方法。例如,这是 class Foo:
的结果/**
* Text from the properties window in EA for Foo.
* @author My Name
* @version 1.0
* @created 26-Oct-2017 12:32:57
*/
class Foo
{
我查看了代码模板编辑器,但像这样的事情似乎都隐藏在一个神奇的功能后面。例如,C++ Class Notes 模板包含 %JAVADOC_COMMENT($wrapLen)
,但我还没有看到我可以在哪里对评论中的内容产生任何影响。
有没有办法在 EA 中自定义 JavaDoc 输出?或者定义我自己的 "Comment Style"?例如,也许我想切换项目的显示顺序,我想在参数之间添加一些空行,或者我想从我的文档块中完全删除 @created
。
您提到的魔法函数也是一个documented宏:
JAVADOC_COMMENT([wrap_length])
Converts the notes for the element currently in scope to javadoc -style comments.
因此您将无法调整宏的工作方式。
但是你当然可以用你自己的评论部分替换标准宏,如果你真的认为那是值得的话。