2011-11-16 38 views
3

有沒有關於如何顯示代碼在做什麼(C或MATLAB)的建議?想象一下,如果你的代碼真的很長,並且你的程序中有很多功能,記錄程序的最好方法是什麼?我知道Java IDE有一種方法來提取註釋,並將它們反饋回顯示所有功能及其輸入和輸出的文檔。我不認爲C或MATLAB有這個功能。在這一點上,我認爲評論是展示代碼中發生的事情的唯一方式,但是如果他們必須通過原始代碼瀏覽評論,可能會使讀者感到困惑。第二種選擇是在諸如Microsoft Word的文本編輯器中寫出算法。是否有這樣的行業標準?用C或MATLAB編碼的組織/顯示算法的方法

謝謝!

回答

5

Java使用的是JavaDoc

對於C,您可以使用Doxygen

我也看到this這表明你也可以用matlab來使用Doxygen!

2

Doxygen的C支持相當不錯。它支持JavaDoc風格和Qt風格標記註釋,以及一些附加功能。有關標記的示例,請參閱手冊。我沒有一個準備好的輸出示例,但它非常可定製。

Octave項目實現了語言和環境,它實際上是一個超集的Matlab,它使用texinfo來記錄它的函數。您可以在手冊的Documentation Tips部分看到標記示例。我建議滾動到頁面底部查看完整的標記示例,而不是閱讀前面冗長的解釋。除了使用Octave內部的幫助外,我幾乎沒有使用texinfo的經驗,但是我相信聯機手冊是從texinfo源生成的,所以它看起來足夠強大。

2

最近版本的MATLAB實際上有一些功能與此非常相似。如果你在面向對象的類中實現你的MATLAB代碼,那麼只需要輸入doc myClassName就可以爲你提供auto-generate documentation - 這與Doxygen非常相似。如果你不使用面向對象的代碼,你可以使用MATLAB publishing從你的腳本和函數生成一個文檔。