如何正確格式化c ++注釋？

Question

任何人都可以建議我在C ++項目中使用的正確格式的注釋嗎？ 我認為有一些javadoc格式的模擬，但我找不到哪一個。 那種事實上的標准是否存在？ 謝謝！

Answer 1

Doxygen經常用於C ++項目（Doxygen也支持其他語言）。 您可以使用Doxygen風格的注釋作為起點（以下是一些示例 ）。 只是保持一致。

Answer 2

你提到javadoc表明你可能會想到doxygen 。 這是一個支持C ++和其他語言的結構化注釋的工具包，可以用HTML生成輸出（如果我沒記錯的話）PDF。 它支持各種注釋樣式，包括一個看起來非常像javadoc的注釋樣式。

它運作良好，並廣泛使用。

Answer 3

作為每種語言的主題，它都備受爭議。

雖然我很欣賞Doxygen的答案，因為它實際上是一種事實上的標准，Doxygen本身支持多種格式。

C ++支持2種注釋樣式：

• /**/多行評論
• //直到評論結束

我建議不要使用前一種風格。 問題是它沒有嵌套，這對於測試目的而言你想要注釋掉整個代碼塊是非常煩人的。

我的2美分，俗話說。