c中的注释方法答案

【问题标题】：Commenting methods in cc中的注释方法
【发布时间】：2013-12-14 18:27:11
【问题描述】：

我想知道是否可以像在 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？

【问题讨论】：

我希望我有你的问题。您几乎可以将任何东西放入 C 中的 cmets。注释被预处理器删除，它们对最终代码没有任何影响。
@V-X：你为什么说：几乎一切？
@MartijnCourteaux: text */ 不是评论的好内容。
@V-X: 哈哈，我懒散了：P
学究，我知道，但仅供参考 C 只有功能。没有方法。

标签： java c comments

【解决方案1】：

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

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

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

【讨论】：

【解决方案2】：

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

【讨论】：

【解决方案3】：

我喜欢这样评论我的函数定义：

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

【讨论】：

【解决方案4】：

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

【讨论】：

【解决方案5】：

像这样的 Doc-cmets 在 C 中并不常用。它们可能在某些 IDE 中用于为函数生成文档，但我不记得曾经在 C 源代码中看到过这些 cmets。

【讨论】：

【解决方案6】：

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

在 C 中，您在 /**/ 中放入的任何内容都被视为 cmets。但我认为@param 在 C.

中没有什么可做的

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

【讨论】：