與MTOC++/Doxygen的

一個面向對象的MATLAB項目的自動文檔我在MATLAB的面向對象的項目，並想自動產生一些文檔。與MTOC++/Doxygen的

經過一番研究，我發現了一個名爲MTOC++這顯然會產生使用Doxygen的（我有沒有經驗）一個文檔方便的工具。

我唯一的問題是，是否爲了使用使用特定的格式（語言？），使微管組織中心++/Doxygen的可以瞭解和記錄我的意見的工具，我需要寫在MATLAB評論？

如果是這樣，那麼這是什麼格式/語言和在哪裏可以找到它的描述？

來源

2015-06-26 Sergey Zykov

後正確地安裝和配置MTOC++/Doxygen的，該文檔被自動創建。

如果要定義個性化的評論針對特定的自定義參數，您可以按照此頁面上的說明：

http://www.ians.uni-stuttgart.de/MoRePaS/software/mtocpp/docs/tools.html

下看的微管組織中心的標題配置選項++過濾。

你所要做的就是編輯mtocpp.conf文件，位於工具/配置文件夾，您將使用格式是這樣的：

add(params) = <parameter1_name> => """Your parameter1 description text in triple quotes""";

一個例子成爲：

add(params) = myVariable => """This variable is defined by me""";

因此，您可以爲參數，字段，額外文檔和全局設置定義個性化註釋。

我相信一定有其他方法來添加註釋和文檔。

我希望這會有所幫助。快樂的編碼。

來源

2015-06-27 07:23:44

您的回答讓我懷疑我對該工具應該做什麼的理解。我認爲這個工具可以在代碼中寫出這些註釋（用於類，方法，屬性，事件），並將它們很好地組織在一個文檔中，就像Matlab中的_doc_命令一樣（但_doc_命令僅創建文檔一次一個班級，而不是一個項目的所有班級）。 –

是的你是對的。這是該工具的功能。您可以使用與我們創建幫助文檔相同的方式在Matlab源文件中添加註釋，即在函數主體之前聲明函數使用％來爲該函數添加描述。在這些註釋中，您可以使用Doxygen命令來進一步格式化文檔。所有的Doxygen命令都以@或\開頭。你可以在這裏找到所有Doxygen命令的文檔：http://www.stack.nl/~dimitri/doxygen/manual/commands.html –

我也建議通過示例文件，它可以在src/docs/+ examples /文件夾。 –

與MTOC++/Doxygen的

回答

相關問題