1

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

是否有任何js工具或EA插件允许开发人员在编写代码时对其代码进行注释,然后可以将其作为构建过程的一部分生成某种.json/.xml/.xmi/.yaml文件,该文件有效地EA模型,然后可以导入到Enterprise Architect中?这与Swagger等工具类似,但不生成html,而是在文件中生成EA模型。我会想象我们的目标是产生用户故事或用例,与演员,验收标准,异常,测试用例等的列表

+1

您在软件设计和分析中所需的内容称为“逆向工程”。此链接可能有所帮助:http://www.sparxsystems.com.au/resources/demos/vea/webinar-visual-execution-analyzer.html – quirimmo

+0

@quirimmo感谢您的评论。 “反向工程”当然是一种方法,但我正在寻找代码驱动的文档 – sarin

+0

所以正如答案中指出的那样,在js中你有js文档,然后为了直接生成文档的html,几乎没有节点工具。但是在你的问题中,你会问如何从代码更改返回序列图。这是逆向工程,从代码文档中这是不可能的。例如,在代码文档中您评论当前的方法。不是类/对象之间的关系,什么序列图实际显示。 – quirimmo

回答

2

我必须承认,我不知道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) { 
} 
相关问题