如何在ANSI C中编写文档注释？

我找不到如何在C中写评论。我的意思是我知道//和/* */，我的意思是我在哪里可以找到好的做法？就像我有一个函数一样，我如何编写@param variable is the value bla bla，就像它在Java中完成的一样？如何在ANSI C中编写文档注释？

这是否有任何标准？或者我可以像我在Java中那样做吗？

来源

2012-01-17 bb2

实际上，你甚至不能在ANSI C中使用''''。只有从C99开始，它们才允许'// //'。（尽管GCC允许它作为扩展）。 – Mysticial 2012-01-17 05:10:03

C中只支持'/ * * /'。''是C++中的一个附加项。 – 2012-01-17 05:12:29

术语“ANSI C”通常是指1989 ANSI标准所描述的语言，但严格来说这是不正确的。 1990年，ISO颁布了相同的标准（包含一些新的介绍性材料和重新编号的部分），ANSI采用了它。 1999年，ISO发布了新的C标准，ANSI也采用了该标准，使1989/1990标准正式过时。在2011年末，ISO发布了另一个新的C标准，ANSI也采用了该标准。除第一个标准外，C标准最初由ISO发布，而不是ANSI - 最好每年参考标准。 – 2012-01-17 05:16:39

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

来源

2012-01-17 05:10:15

有没有标准，按照标准的贵公司的授权。
从项目创建文档的流行方式是使用Doxygen。

来源

2012-01-17 05:10:15

一个选项是使用doxygen格式的书写评论 - 这有额外的好处是能够为您的代码生成HTML /乳胶和其他种类的文档。

来源

2012-01-17 05:12:00

您可以使用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 
*/

（一些更多的例子in the doxygen manual）

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

apt-get install doxygen doxygen-gui graphviz

运行gui调用doxywizard并使用Wizard设置，只有JAVADOC_AUTOBRIEF必须在“Expert”设置中设置英格斯。

来源

2015-12-22 05:52:54 rubo77

一个很好的例子。 – Drew 2015-12-22 06:06:36

如何在ANSI C中编写文档注释？

回答

相关问题