Javascript代碼驅動的文檔到Enterprise Architect

我們的團隊在AngularJS，node.js和mySql \ Oracle上開發。作爲我們應用文檔的一部分，我們的組織希望我們能夠在Enterprise Architect中捕獲我們的用戶故事/用例，然後讓它生成交互的序列圖。目前這是一個手動過程，每次應用程序更改時，文檔都必須手動更改。這是時間和資源密集型的。Javascript代碼驅動的文檔到Enterprise Architect

是否有任何js工具或EA插件允許開發人員在編寫代碼時對其代碼進行註釋，然後可以將其作爲構建過程的一部分生成某種.json/.xml/.xmi/.yaml文件，該文件有效地EA模型，然後可以導入到Enterprise Architect中？這與Swagger等工具類似，但不生成html，而是在文件中生成EA模型。我會想象我們的目標是產生用戶故事或用例，與演員，驗收標準，異常，測試用例等的列表

來源

2017-05-26 sarin

您在軟件設計和分析中所需的內容稱爲「逆向工程」。此鏈接可能有所幫助：http://www.sparxsystems.com.au/resources/demos/vea/webinar-visual-execution-analyzer.html – quirimmo

@quirimmo感謝您的評論。「反向工程」當然是一種方法，但我正在尋找代碼驅動的文檔 – sarin

所以正如答案中指出的那樣，在js中你有js文檔，然後爲了直接生成文檔的html，幾乎沒有節點工具。但是在你的問題中，你會問如何從代碼更改返回序列圖。這是逆向工程，從代碼文檔中這是不可能的。例如，在代碼文檔中您評論當前的方法。不是類/對象之間的關係，什麼序列圖實際顯示。 – quirimmo

我必須承認，我不知道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) { 
}

來源

2017-05-26 08:48:18 Booster2ooo

Javascript代碼驅動的文檔到Enterprise Architect

回答

相關問題