我正在給C++程序添加註釋。 比方說，我們有這樣的事情：在C++中註釋
string House:: getName(int &size){
return name;
}
在Java中，當你寫旁邊的星號上述評論你的名字他們是這樣的：
/*
* @param size It passes the number of rooms.
@return name. It returns name of the house
*/
什麼是在C這樣的格式++？
如果您使用Visual Studio，here是註釋文檔的規範。
您指的是Javadoc，您可以在C++中使用相同風格的註釋和相同的編輯器和外部工具。
評論文檔沒有C++「標準」。
+1，即doxygen。 –
好吧，工具+0.5，說明評論不僅僅關於嵌入元數據和自由評論應該保持自由的形式; +）。 –
沒有具體的規定。評論是評論，他們被忽略和扔掉，所以你可以以任何你喜歡的方式塑造他們。
如果您想要使用解釋註釋的程序，例如doxygen，那麼您必須查看該程序的參考。
如果您從代碼中提取文檔，那麼您需要遵循適當的評論格式。例如，我們使用DOxygen，所以我們必須遵循Doxygen規則。
如果您不打算爲文檔提取註釋，則適用簡單的良好編碼實踐。
您是否在尋找類似於javadoc的文檔生成工具？ – zdan
我認爲有一個關於如何做文檔C++代碼的約定。這就像我給你一個Java代碼的例子。 – ucas
另一種選擇是使用'number_of_rooms'作爲參數名稱而不是'size'。讓你解釋它是什麼。 –