Doxygen集成（非託管）Visual C++ 2005

Question

我們正在慢慢轉向在一個大型C++項目中引入Doxygen的更好標準化的評論。我個人覺得在評論中輸入很麻煩，特別是因爲Java IDE非常擅長自動化。

所以我想知道可能有哪些工具？搜索變成了DoxyComment看起來相當不錯，這是最好的/標準的工具還是有其他值得一看？

Answer 1

Atomineer是一個工具，我和其他一些人一直在使用Doxygen標記來記錄非託管C++代碼。這不是免費的，但它很便宜，可能值得一試： http://www.atomineerutils.com/products.php

Answer 2

如果輸入元註釋是doxygen的說明是您的評論寫作工作的重要組成部分，你做錯了。

評論不應該包括可以由工具自動確定的事情，任何程序員都將確定來自其他人的信息（或更多）。參數名稱比任何工具。

另一種看待這個問題的方法是，doxygen已經做了很好的工作來呈現可以自動確定的東西。你不需要寫：「B :: B構造一個B對象」，因爲doxygen會自動將它分類到文檔的構造器部分。

專注於非顯而易見的事情，並花時間思考自己寫的內容。

通常很多函數和變量都不需要單獨的註釋，因爲名稱足夠描述，或者在描述多個成員如何交互的類級註釋中更好地解釋它們。