我找不到如何用 C 写评论。我的意思是我知道//and /* */，我的意思是我在哪里可以找到好的做法？就像我有一个函数一样，我该如何编写@param variable is the value bla bla，就像它是用 Java 完成的一样？
这有什么标准吗？或者我可以像在 Java 中那样做吗？
问问题
18415 次
4 回答
13
有很多不同的标准，如果你想生成文档，试试doxygen
于 2012-01-17T05:10:15.810 回答
10
您可以使用 javadoc 标准，然后使用理解 javadoc 的doxygen生成文档。
在 doxygen 中，我建议使用JAVADOC_AUTOBRIEF设置为YES. 如果 JAVADOC_AUTOBRIEF 标记设置为 YES，则 doxygen 会将 Javadoc 样式注释的第一行（直到第一个点）解释为简要说明。
类定义示例：
/**
* A brief description. A more elaborate class description
* @param bool somebool a boolean argument.
* @see Test()
* @return The test results
*/
（ doxygen 手册中的更多示例）
安装非常简单，有一个 GUI 和一个漂亮的图形可视化可用：
apt-get install doxygen doxygen-gui graphviz
运行 gui 调用doxywizard并使用向导设置，只需JAVADOC_AUTOBRIEF在“专家”设置中进行设置。
于 2015-12-22T05:52:54.737 回答
5
没有标准遵循贵公司规定的标准。
从项目创建文档的一种流行方法是使用doxygen。
于 2012-01-17T05:10:15.787 回答
3
一种选择是使用 doxygen 格式来编写注释——这还有一个额外的好处，就是能够为您的代码生成 html/latex 和其他类型的文档。
于 2012-01-17T05:12:00.260 回答