如何在ANSI C中编写文档注释？[关闭]

Question

我找不到用C语言写注释的方法。我的意思是我了解//和/* */，我的意思是我在哪里可以找到好的做法？就像我有一个函数一样，如何编写@param variable is the value bla bla，就像在Java中一样？

对此有任何标准吗？还是可以像在Java中那样做？

Answer 1

有许多不同的标准，如果要生成文档，请尝试 doxygen

Answer 2

没有遵循您公司强制执行的标准的标准。
从项目创建文档的一种流行方法是使用 doxygen 。

Answer 3

您可以使用Javadoc标准，然后使用理解Javadoc的 doxygen 来生成文档。

在doxygen中，我建议使用选项JAVADOC_AUTOBRIEF设置为YES。如果JAVADOC_AUTOBRIEF标记设置为YES，那么doxygen会将Javadoc样式的注释的第一行（直到第一点）解释为简短描述。

类定义示例： 通用标签

（doxygen手册中的其他示例 ）

安装真的很简单，有一个GUI和一个漂亮的图形化可视化工具，可用于： 通用标签

运行gui调用doxywizard并使用向导设置，只需在“专家”设置中在那里设置JAVADOC_AUTOBRIEF。

Answer 4

一种选择是使用doxygen格式编写注释-这具有能够为您的代码生成html / latex和其他类型的文档的额外好处。