当我们在Java中使用/ ** * /注释风格,它有那些注解@参数, 或@ NUM1,这使得更容易阅读的评论,并删除谁可以出现歧义。例如,如果你想在给num1
您的评论的引用,通过写@num1
颜色的变化,你知道注释是指在参数num1
,但如果你说num1
,参数的颜色保持不变,说到硬阅读并可能与具有相同名称的另一个变量混淆。这只是一个例子。C++(Visual Studio)有Java风格的评论吗?
的Java风格:
/**
* @param num1
* @param num2
*/
public void sum(int num1, int num2) {
...
}
这些注释适用于Java文档。你可以在c/C++中使用类似的工具。你必须使用doxygen和它的语法。 – mko
你在说VS吗?那么https://msdn.microsoft.com/en-us/library/ms177246.aspx –
C++没有紧密集成的注释处理器。许多人使用Doxygex进行这样的工作,非常好的程序。 –