C++的类Javadoc文档

xe55xuns  于 2022-11-27  发布在  Java
关注(0)|答案(6)|浏览(144)

是否有类似的文档生成系统,如Javadoc,for C++?Javadoc产生很好的输出;如果你能在其他语言中使用类似的东西就太好了。

v6ylcynt

v6ylcynt1#

有几个工具可以像JavaDoc for C一样工作,最流行的工具可能是doxygen。它可以处理类似JavaDoc的注解,也可以处理几种语言(例如,C,C,Java,Objective-C,Python,PHP,C#)。它非常好地支持使用CSS调整HTML输出的样式(参见users list的示例文档)。
选择文档系统时的两个重要问题是确保它允许您

  • 记录您感兴趣的实体。您是要根据代码结构还是根据其他模块划分来记录系统。
  • 将输出格式化成您想要的格式。当文件符合您的一般项目风格时,这是较佳的作法。

我们使用doxygen的经验是,它非常容易设置和使用,并且生成的输出也非常容易调整。不幸的是,doxygen并不完美,所以在某些情况下,有必要解决doxygen解析器崩溃的问题。一定要仔细检查所有生成的文档。

jgovgodb

jgovgodb2#

你不能专门使用javadoc,但是有几个工具可以满足你的需要。大多数人倾向于使用的是Doxygen。下面是Doxygen和Doc++的一些链接:
Doxygen
Doc++

daolsyd0

daolsyd03#

doxygen支持很多功能(甚至更多)Doxygen

at0kjp5o

at0kjp5o5#

我刚开始在Python项目中使用Sphinx,它的主页上写着“C/C++也已经被支持了”。
它使用一个名为“reStructuredText“的轻量级标记。
我刚刚开始在Python项目中使用它,非常喜欢输出的外观。

mefy6pfw

mefy6pfw6#

Standardese home page
Standardese的目标是成为下一代Doxygen。它由两部分组成:库和工具。
该库旨在成为易于扩展和定制的文档前端,它在libclang的帮助下解析C++代码并提供对它的访问。
该工具驱动库为用户指定的文件生成文档,它支持多种输出格式,包括Markdown和HTML,以及实验性的Latex和手册页。
Standardese code repository还指出了一些博客文章:

相关问题