代碼文檔創建工具德爾福

可能重複：
Code documentation for delphi similar to javadoc or c# xml doc 代碼文檔創建工具德爾福

我要開始記錄一個非常大的Delphi應用程序，它目前還沒有任何文件。我的同事建議使用javadoc類型的文檔樣式，因爲我們可以運行一個自動化程序來創建漂亮的可搜索文檔。

(* Description of the function    
@param S  some string 
@param Index the index of string s 
@retval TRUE condition where it is true 
@retval FALSE otherwise. 
@see   IndexOf 
@see   Sort 
@see   Sorted 
*) 
bool Stringlist::Find(const char *S, int &Index) 
{ 
    [...] 
}

這是我可以完成我的項目有意義的文檔的最佳方式嗎？如果是的話，什麼是處理這些類型評論的好方案。到目前爲止，我有推薦給我的Doc-O-Matic。

如果是使用任何程序很老，它一直不斷自1993年左右的發展，已經儘管許多不同的作者，許多不同的風格，集成開發環境，標準等

來源

2011-02-08 Daisetsu

你是否正在記錄應用程序或其代碼？ – 2011-02-08 19:13:45

我正在記錄代碼 – Daisetsu 2011-02-08 19:15:37

看看SynProject，一個用Delphi編寫的開源工具。

它被設計用來處理一個完整的文檔工作流程，從規格到發行說明，其中包括測試，建築和設計;當然還有一個集成的Delphi解析器可以從現有的Delphi源代碼生成架構文檔。

對於體系結構文檔，源代碼可以提取註釋（ALA JavaDoc的），則嵌入此文本到主架構文檔（具有類層次圖和單元的依賴關係）。

您在專門的文本編輯器使用類似wiki的語法寫一個純文本文件，然後創建SynProject從它做好格式化的Word文檔。一些嚮導可用於訪問內容。但由於它以純文件形式存儲，所以多個程序員可以使用任何SCM工具（SVN，Fossil ...）在其上編寫代碼。

舉例來說，我現在用它編寫維護文檔巨大的老Delphi應用程序（代碼約2,000,000行用Delphi編寫的5和6），之前沒有可用文檔。您描述了對代碼所做的更改（通過引用單位/類/方法），然後該工具將更新所有文檔以反映和跟蹤這些修改。 SynProject被設計成一些非常「微妙」的調控細則（IEC 62304）爲柔順的，但可用於任何項目，由於其獨特的「扁平化」設計。

來源

2011-02-08 20:12:53

-3

如果您只是想根據功能註釋記錄您的源代碼，我會推薦您使用Doc-O-Matic。

但真正的問題是：你應該記錄你的源代碼？我不這麼認爲。根據TDD和XP，你不應該評論你的代碼。你的代碼應該包含很好的過程名稱，這些名稱確實表明過程的作用。所以你可以考慮不記錄它，只是重構它，所以它可以很容易理解。

來源

2011-02-08 20:41:46

創建源代碼文檔沒有「最佳途徑」。因此，任何答案在某種程度上都是主觀的。

首先，您必須選擇您的源內文檔樣式。您可以使用「原生」評論，JavaDoc或XMLDoc。選擇文件格式後，應選擇文件標準。

而且你需要一個文檔生成到發佈的源文檔（HTML，PDF或其他格式）

至於Delphi源代碼，目前是最支持JavaDoc風格。我試過DelphiCodeToDoc（它使用JavaDoc）來生成html文檔，它工作。我想你可以找到更多的支持JavaDoc的Delphi源文檔生成器。

我還是喜歡XMLDoc款式和Delphi Documentation Guidelines。這是主觀的。我認爲現在最好的XMLDoc Delphi文檔生成器是Doc-O-Matic。它也支持JavaDoc風格，我目前正在試驗它。它不支持Delphi Documentation Guidelines中提到的所有標記，例如它不支持<列表>標記，但可以使用<代替>，並生成可敬的文檔。

嘗試有哪些可用的選項，並選擇你喜歡的更多。

來源

2011-02-08 20:52:48 kludg

代碼文檔創建工具德爾福

回答

相關問題