2017-08-16 58 views
0

当我们在Java中使用/ ** * /注释风格,它有那些注解@参数, 或@ NUM1,这使得更容易阅读的评论,并删除谁可以出现歧义。例如,如果你想在给num1您的评论的引用,通过写@num1颜色的变化,你知道注释是指在参数num1,但如果你说num1,参数的颜色保持不变,说到硬阅读并可能与具有相同名称的另一个变量混淆。这只是一个例子。C++(Visual Studio)有Java风格的评论吗?

的Java风格:

/** 
* @param num1 
* @param num2 
*/ 
public void sum(int num1, int num2) { 
    ... 
} 
+1

这些注释适用于Java文档。你可以在c/C++中使用类似的工具。你必须使用doxygen和它的语法。 – mko

+1

你在说VS吗?那么https://msdn.microsoft.com/en-us/library/ms177246.aspx –

+1

C++没有紧密集成的注释处理器。许多人使用Doxygex进行这样的工作,非常好的程序。 –

回答

4

C++标准没有定义任何评论语义。

然而,有扩展,如Doxygen,cldocDOC++,它们提供了类似的功能。

检查您的IDE /文本编辑器支持的Doxygen语法高亮显示。

+0

谢谢你的回答! – Linksx

1

C++不来与这些意见的处理器,但它们确实存在。我在13年前使用了一个。我认为它被称为... cppdoc,但不要引用我。

+0

http://www.cs.scranton.edu/~doc/cppdoc/ – Thomas

+2

@downvoter请解释。它不存在? 13年前我没有使用它?莫名其妙。 – EJP

+0

@EJP感谢这个答案,我会检查! – Linksx

6

它无关,与语言本身,但也有很了解“的Javadoc”风格的注释文件产生的程序。

例如Doxygen。像Java与Javadocs确实

+0

谢谢你的回答! – Linksx