如何正确评价c语言中的方法？

如何正确评价c语言中的方法

Java中有类似的东西吗

/*
*Returns the value of the sin(x)
*
*@param..?
.@return..?
.

?
?

谢谢你的建议。

---

这是我如何评论函数定义的：

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

---

下面是我对函数定义的注释：

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

---

没有“正确的注释方式”这样的东西——注释不重要，只要满足编译器的要求，它们也不重要

---

我认为，您真正想问的是如何评论以便使用一些外部工具（如doxygen）。这对语言来说并不重要，但对工具来说更重要——你需要阅读工具的文档以了解它的期望值。

没有“正确的注释方式”这样的东西——注释不重要，只要你满足编译器的要求，它们也不重要

---

我认为，您真正想问的是如何评论以便使用一些外部工具（如doxygen）。这对语言来说不是很重要，而是对工具来说很重要。您需要阅读工具的文档，了解它需要什么

/

用于单行（简称与变量相关的重要信息

/**/

用于多行（主要用于描述）

如何使用它

/*

This is a Addition function. It takes two variables of int type and yields the addition of it.

*/

int add(int a, int b){

 int c = 0; // Variable to store result
 return c; 

}

---

请参见，有两种类型的注释

/

用于单行（简称与变量相关的重要信息

/**/

用于多行（主要用于描述）

如何使用它

/*

This is a Addition function. It takes two variables of int type and yields the addition of it.

*/

int add(int a, int b){

 int c = 0; // Variable to store result
 return c; 

}

---

微软在网站上提供了一些指导

• 将注释放在单独的一行上，而不是放在代码行的末尾
• 注释文本以大写字母开头
• 以句点结束注释文本
• 在注释分隔符（//）和注释文本之间插入一个空格，如下例所示

---

最后，正如@Mah所说，如果你是项目中唯一的一个人，那就没关系了。否则，应该事先商定某种约定，并遵守这些约定，以确保可读性。

微软在

• 将注释放在单独的一行上，而不是放在代码行的末尾
• 注释文本以大写字母开头
• 以句点结束注释文本
• 在注释分隔符（//）和注释文本之间插入一个空格，如下例所示

---

最后，就像@Mah所说的，如果你是项目中唯一的一个人，那没关系。否则，应该事先商定某种约定，并遵守其可读性。

C中没有方法（AFAIK）C中没有方法（AFAIK）也许@JaLe29在问是否有公认的评论标准或惯例。这取决于公司。@BitFiddlingCodeMonkey我的假设是，这个问题的目的与使用外部工具有关。他的例子显示了人们通常会在Java中使用doxygen来生成文档以注释的doxygen语法为首是一个很好的提示。@mah你很精明。这超出了我的理解。也许@JaLe29是在问是否有一个公认的注释标准或惯例。这取决于公司。@bitfidlingcodemonkey我认为这个问题的目的与使用外部工具有关，这是他的例子为了使用doxygen生成文档，人们通常会使用Java编写文档。他提到Java，再加上注释中的doxygen语法，这是一个很好的提示。@mah，你很精明。这超出了我的想象。