Question

我想知道是否可以像在java语言中注释代码那样在c中注释方法？

/**
 * 
 * @param x
 * @param y
 * @return
 */
protected boolean myMethod(int x, int y) {



  return true;
}

在c

中的方式相同

 /**
 * 
 * @param x
 * @param y
 * @return
 */
int myMethod(int x, int y) {



  return 1;
}

当然这取决于程序员，但我想知道c程序员是否使用这些@param？

Answer 1

当然这取决于程序员，但我想知道是否 c程序员是否使用这些@param？

在C中，无论你放在/**/内的什么都被视为评论。但我不认为@param在 C中有任何关系。

就@而言，Java中的@用于Javadoc功能。

Answer 2

像这样的Doc-comments在C中并不常用。它们在某些IDE中可能对生成函数文档很有用，但我不记得在C源代码中看到过这些注释。

Answer 3

您可以使用doxygen获取任何编程语言的文档，例如C，Objective-C，C＃，PHP，Java，Python，IDL（Corba，Microsoft和UNO / OpenOffice风格），Fortran，VHDL， Tcl，并在某种程度上D

Answer 4

我喜欢评论我的函数定义，如：

/*****************************************************************************
 * @brief   
 * @author  
 * @date    
 * @return  
 * @arg
 * @note     
 *
 *****************************************************************************/

Answer 5

以任何易于理解的方式发表评论都是可以的。在java中，您以特定格式发表评论，以允许javadoc生成文档。

而不是javadoc，在C（和许多其他语言）中，DOXYGEN通常用于从结构化注释生成文档。
幸运的是，语法与javadoc几乎完全相同。

查看http://www.doxygen.nl/。

Answer 6

Java中的@用于Javadoc功能。这不是C语言的一部分，因此注释中将忽略@。这些类型的东西通常依赖于团队/公司，这是一个惯例问题。

评论方法c

6 个答案: