编写doxygen代码注释的最佳工具或技术是什么

时间:2009-07-31 11:01:52

标签: doxygen documentation-generation

必须为公共c ++头文件提供大量注释。很难格式化和包装doxygen评论。是否存在某些格式化工具?

具有第80个字符的自动换行等功能,轻松实现视觉功能分组。理想情况下,文档编写者单独准备文档,然后使用带代码的doxytags将其注入或链接。

目前我们使用记事本/ IDE来记录代码。

2 个答案:

答案 0 :(得分:3)

你没有说你正在使用哪个IDE - 如果你在Visual Studio中工作,那么我写了一个可能对你有用的插件(AtomineerUtils) - 它生成/更新XML, Doxygen或JavaDoc文档注释在源文件中,并且可以为您自动换行和格式化注释,从而最大限度地减少您需要做的工作以保持它们的整洁。它还使注释与代码保持同步(参数,类型参数,抛出的异常等)。

(它支持C,C ++,C ++ / CLI,C#,Visual Basic和Java,在Visual Studio 2010,2008,2005中)。

答案 1 :(得分:1)

Emacs + doxymacs对我来说很好。