在c ++中评论

Question

我正在为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 ++中执行此操作的格式是什么？

Answer 1

您指的是Javadoc，您可以使用相同的编辑器和外部工具在C ++中使用相同风格的注释。

评论文件没有C ++“标准”。

Answer 2

如果要从代码中提取文档，则需要遵循相应的注释格式。例如，我们使用DOxygen，因此我们必须遵循Doxygen规则。

如果您不打算提取文档注释，那么适用简单的良好编码实践。

Answer 3

没有具体规定。评论是评论，它们会被忽略并丢弃，因此您可以以任何您喜欢的方式塑造它们。

如果你想使用一个解释注释的程序，例如doxygen，那么你必须查看该程序的引用。

Answer 4

如果您使用的是Visual Studio，here是评论文档的规范。