在C语言中的注释方法

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呢？

- user2991252

---

我希望我有你的问题。在 C 语言中，几乎可以将任何东西放入注释中。注释将被预处理器移除，并且对最终代码没有任何影响。 - V-X

@V-X：为什么你说“几乎所有”？ - Martijn Courteaux

@MartijnCourteaux：文本*/不是一个好的注释内容。 - V-X

@V-X：哈哈，我笑了 :P - Martijn Courteaux

我知道这有点吹毛求疵，但是FYI，C只有函数，没有方法。 - Luc M

Answer 1

我喜欢这样注释我的函数定义：

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

- Fiddling Bits

Answer 2

当然，由程序员自行决定，但我想知道 C 程序员是否使用这些 @param？在 C 中，你将所有内容放入 /**/ 中都会被视为注释。但我认为 @param 在 C 中没有任何作用。至于 @，Java 中的 @ 是用于 Javadoc 功能。

- Rahul Tripathi

Answer 3

这样的文档注释在C语言中并不常用。它们可能对某些集成开发环境有用，以生成函数文档，但我不记得曾经在C源代码中看到过这些注释。

- Tim Pierce

Answer 4

您可以使用doxygen来为任何编程语言（如C、Objective-C、C#、PHP、Java、Python、IDL（Corba，Microsoft和UNO/OpenOffice版本）、Fortran、VHDL、Tcl以及在某种程度上的D）编写文档。

- Kamlesh Arya

Answer 5

以易于理解的方式进行评论是可以的。在Java中，您需要按照特定格式进行注释，以便Javadoc生成文档。

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

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

- Xiaolei Zhu

Answer 6

Java中的@是用于Javadoc功能的。这不是C语言的一部分，因此在注释中@将被忽略。这些类型的事情通常取决于团队/公司，并且是惯例问题。

- edtheprogrammerguy