面向企业架构师的Javascript代码驱动文档

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

---

是否有任何js工具或EA插件允许开发人员在编写代码时对其进行注释，然后作为构建过程的一部分生成某种.json/.xml/.xmi/.yaml文件，该文件中有效地包含EA模型，然后可以导入Enterprise Architect？这与Swagger之类的工具类似，但它不是生成html，而是在文件中生成EA模型。我想象的目标是生成一个用户故事或用例列表，其中包含参与者、验收标准、异常、测试用例等。我必须承认，我对EA一无所知，但作为更一般的回答，我建议您看看JSDoc。它允许您根据评论构建文档：

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

---

您在软件设计和分析中所寻找的被称为“逆向工程”。此链接可能会有所帮助：@quirimo感谢您的评论。“逆向工程”当然是一种方法，但我正在寻找代码驱动的文档，正如答案中所指出的，在js中，你有js文档，然后有一些带有节点的工具可以直接生成文档的html。但在您的问题中，您会问如何从代码更改中恢复序列图。这是逆向工程，从代码文档中是不可能的。例如，在代码文档中注释当前方法。不是类/对象之间的关系，而是序列图实际显示的内容。试着看一看他们在分析器中放入代码的视频，似乎图在分析代码时被更新了。不幸的是，我很早以前就从EA转向了视觉范式，所以我对EAT并没有太多的了解。在EA中没有这样的东西。你必须自己写剧本。你应该知道你的问题不是你问的那样。投票结束。