2011-07-21 18 views
2

我正在開發一個項目,其文檔非常少,並且也以評論形式提供。這件事正在浪費我很多時間。我正在通過Source Insight等工具幫助完成代碼。最終事情會奏效,但如果有新來的人進來,他將不得不再次經歷同樣的過程。爲了改變它,我想開始記錄這些東西。用於創建文檔的軟件? (Large Source Code)

代碼使用C和C++,並跨越GB。我正在尋找一些工具(免費)來記錄它。我想過使用Wiki,但我不認爲我可以單獨使它工作,因爲創建和編輯頁面的整個過程是漫長而乏味的。我需要一個工具,可以將知識轉儲(也可以標記它),並提供搜索功能。我也想保持它在本地局域網中更新。

有什麼建議?

回答

7

你應該考慮使用Doxygen,它的自由和優秀。

+0

+1 [doxygen](http://www.stack.nl/~dimitri/doxygen/)。這是我第一次接觸這樣的問題。我們將運行doxygen作爲夜間構建的一部分,以便文檔始終在源代碼的24小時內運行(在每個構建中運行它都耗費太多時間)。 –

+0

我正在研究這個問題,但它將如何提供搜索功能? – Ankit

+0

@Ankit:[「包括一個快速的,基於等級的搜索引擎,用於搜索類和成員文檔中的字符串或單詞(基於PHP)。」](http://www.stack.nl/~dimitri/doxygen/features .html) –

0

Doxygen是一個免費且非常流行的源代碼文檔工具。它易於使用並以多種不同格式生成文檔,包括HTML,Latex XML和MS Help。

0

Doxygen的文檔,如其他人所建議的。 我們使用OpenGrok進行搜索。它可以索引多個項目,速度非常快。