Enterprise Architect 的 Javascript 代码驱动文档答案

【问题标题】：Javascript code driven documentation to Enterprise ArchitectEnterprise Architect 的 Javascript 代码驱动文档
【发布时间】：2017-05-26 08:35:03
【问题描述】：

我们的团队在 AngularJS、node.js 和 mySql\Oracle 上进行开发。作为我们应用程序文档的一部分，我们的组织希望我们在 Enterprise Architect 中捕获我们的用户故事/用例，然后让它生成交互的序列图。目前这是一个手动过程，每次应用程序更改时，文档都必须手动更改。这是时间和资源密集型的。

是否有任何 js 工具或 EA 插件允许开发人员在编写代码时对其进行注释，然后可以在构建过程中生成某种 .json/.xml/.xmi/.yaml 文件，该文件实际上具有EA 模型，然后可以导入到 Enterprise Architect 中吗？这与 Swagger 等工具的方式类似，但不是生成 html，而是在文件中生成 EA 模型。我想象的目标是生成一个用户故事或用例列表，包括 Actor、验收标准、异常、测试用例等

【问题讨论】：

您在软件设计和分析中寻找的东西称为“逆向工程”。此链接可能会有所帮助：sparxsystems.com.au/resources/demos/vea/…
@quirimmo 感谢您的评论。 “逆向工程”当然是一种方法，但我正在寻找代码驱动文档
所以正如答案中所指出的，在 js 中你有 js doc，然后几乎没有带有 node 的工具可以直接生成 doc 的 html。但是在您的问题中，您询问如何从代码更改中恢复序列图。这是逆向工程，这在代码文档中是不可能的。例如，在代码文档中，您可以注释当前方法。不是类/对象之间的关系，序列图实际显示的是什么。
尝试看一下他们将代码放入分析器的视频，似乎分析代码的图表已更新。不幸的是，我很久以前从 EA 切换到 Visual Paradigm，所以我不太了解 EA
在 EA 中没有这样的东西。你必须自己编写脚本。你应该知道你的问题是你问的方式。投票结束。

标签： javascript enterprise-architect documentation-generation

【解决方案1】：

我必须承认我对 EA 一无所知，但作为一个更通用的答案，我建议你看看 JSDoc。它允许您基于 cmets 构建文档：

/**
 * Represents a book.
 * @constructor
 * @param {string} title - The title of the book.
 * @param {string} author - The author of the book.
 */
function Book(title, author) {
}

【讨论】：