記錄代碼頭和源文件

這是一個簡單的問題。我在Doxygen的文檔之後記錄我的代碼，但我有一個問題：我需要在哪裏文檔？在標題上，來源或兩者上？我知道這不是一個規則，但我想知道你對此的看法，以及你在代碼中做了什麼以及你爲什麼這樣做。例如：我正在記錄頭文件，這很好，代碼的外觀增加了，但是當我查看源代碼（.cpp）文件時，我很害怕，因爲沒有文檔，代碼也不漂亮，我的意思是，而不是邏輯，但在美（縮進）。而且大家都知道，即使代碼不漂亮（在C++中很難實現），它的文檔也會變得最酷並且更易於閱讀。記錄代碼頭和源文件

謝謝大家。（請記住，在你開始寫道德課之前，要知道我知道這不是一個規則，我只是想知道你在做什麼）。

來源

2014-02-24 SH.0x90

可能重複[在哪裏放置一個內部庫的doxygen註釋塊 - 在H或在CPP文件？]（http://stackoverflow.com/questions/355619/where-to-put-the-doxygen-註釋塊爲內部庫在h或在cpp） –

堆棧溢出真的不是徵求主觀意見的地方。 – mah

在完美的世界中，人們不應該閱讀源代碼。因此，在更改相關代碼時，將doxygen註釋放在更容易更改的地方。 –

我個人更喜歡用這種東西記錄h文件。需要使用您的API的人可能需要您的標題，但不是您的cpp。沒有標題，人們將永遠不需要你的CPP。將文檔保存在需要它的每個人都可以獲得的地方。

來源

2014-02-24 17:23:18 m24p

雖然在閱讀http://stackoverflow.com/questions/355619/where-to-put-the-doxygen-comment-blocks-for-an-internal-library-in-h-or-in-cpp我是不太確定。 – m24p

記錄代碼頭和源文件

回答

相關問題