Doxygen集成（非托管）Visual C++ 2005

Question

我们正在慢慢转向在一个大型C++项目中引入Doxygen的更好标准化的评论。我个人觉得在评论中输入很麻烦，特别是因为Java IDE非常擅长自动化。

所以我想知道可能有哪些工具？搜索变成了DoxyComment看起来相当不错，这是最好的/标准的工具还是有其他值得一看？

Answer 1

Atomineer是一个工具，我和其他一些人一直在使用Doxygen标记来记录非托管C++代码。这不是免费的，但它很便宜，可能值得一试： http://www.atomineerutils.com/products.php

Answer 2

如果输入元注释是doxygen的说明是您的评论写作工作的重要组成部分，你做错了。

评论不应该包括可以由工具自动确定的事情，任何程序员都将确定来自其他人的信息（或更多）。参数名称比任何工具。

另一种看待这个问题的方法是，doxygen已经做了很好的工作来呈现可以自动确定的东西。你不需要写：“B :: B构造一个B对象”，因为doxygen会自动将它分类到文档的构造器部分。

专注于非显而易见的事情，并花时间思考自己写的内容。

通常很多函数和变量都不需要单独的注释，因为名称足够描述，或者在描述多个成员如何交互的类级注释中更好地解释它们。