如何正确格式化c ++注释?

时间:2010-07-13 07:40:41

标签: c++

有人可以建议我在C ++项目中使用的正确格式的注释吗?我认为有javadoc格式的模拟,但我找不到哪一个。那种事实上的标准是否存在?谢谢!

3 个答案:

答案 0 :(得分:17)

Doxygen经常用于C ++项目(Doxygen也支持其他语言)。您可以使用Doxygen风格的注释作为起点(here are some examples)。只是保持一致。

答案 1 :(得分:2)

您提到的javadoc表明您可能会考虑doxygen。这是一个支持C ++和其他语言的结构化注释的工具包,可以用HTML生成输出(如果我没记错的话)PDF。它支持各种注释样式,包括一个看起来非常像javadoc的注释样式。

效果很好,并且被广泛使用。

答案 2 :(得分:2)

作为每种语言的主题,它都备受争议。

虽然我很欣赏Doxygen的答案,因为它实际上是一种事实上的标准,Doxygen本身支持多种格式。

C ++支持2种注释样式:

  • /**/多行评论
  • //直到评论结束

我建议不要使用前一种风格。问题是它没有嵌套,这对于测试目的而言非常烦人,你想要注释掉整个代码块。

我的2美分,俗话说。