有几种工具的工作方式类似于JavaDoc for C
。最受欢迎的工具可能是doxygen。它可以处理类似JavaDoc的注释,也可以处理多种语言(例如C
,C,Java,Objective-C,Python,PHP,C#)。它对使用CSS调整HTML输出的样式具有很好的支持(有关示例文档,请参见用户列表)。
选择文档系统时,两个重要的问题是确保它允许您
- 记录您感兴趣的实体。是否要按照代码结构或其他模块划分来记录系统。
- 根据需要获取格式化的输出。当文档适合您的常规项目样式时,这是更可取的。
我们对doxygen的经验是,它非常容易设置和使用,并且输出结果也很容易调整。不幸的是,doxygen并不完美,因此在某些情况下,有必要解决doxygen解析器崩溃的怪癖或错误。确保仔细检查所有生成的文档。



