如何在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的{​​{1}}选项。如果JAVADOC_AUTOBRIEF标记设置为YES，则doxygen会将Javadoc样式注释的第一行（直到第一个点）解释为简要描述。

类定义的示例：

YES

（更多示例in the doxygen manual）

安装非常简单，有一个GUI和一个很好的图形可视化，可用：

/**
 * A brief description. A more elaborate class description
 * @param bool somebool a boolean argument.
 * @see Test()
 * @return The test results
 */

运行gui调用apt-get install doxygen doxygen-gui graphviz 并使用向导设置，只需在“专家”设置中设置doxywizard。

Answer 4

一个选项是使用doxygen格式编写注释 - 这样可以为您的代码生成html / latex和其他类型的文档。