用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， 这里是注释文档规范。