在一个大型 C++ 项目中，我们正慢慢朝着更标准化的评论方向发展，引入了 Doxygen。我个人觉得在注释中打字很痛苦，特别是因为 Java IDE 非常擅长自动化这一点。
所以我想知道可能有什么工具？搜索出现了看起来相当不错的DoxyComment，这是最好的/标准工具，还是还有其他值得一看的工具？
问问题
340 次
2 回答
1
Atomineer 是一个工具，我和其他一些人一直在使用它来记录带有 Doxygen 标记的非托管 C++ 代码。它不是免费的，但很便宜，可能值得一试： http: //www.atomineerutils.com/products.php
于 2011-04-07T02:21:00.230 回答
1
如果键入作为 doxygen 指令的元评论是您撰写评论工作的重要部分，那么您做错了。
注释不应包括可以由工具自动确定的内容，任何程序员都会从参数名称中确定与任何工具一样多（或更多）的信息。
另一种看待这一点的方式是，doxygen 在呈现可以自动确定的内容方面已经做得很好。你不需要写：“B::B 构造一个 B 对象”，因为 doxygen 会自动将它分类到文档的构造函数部分。
专注于不明显的东西，花时间思考你在写什么。
通常许多函数和变量不需要单独的注释，因为要么名称足够描述性，要么在描述多个成员如何交互的类级注释中更好地解释它们。
于 2011-04-07T02:27:35.430 回答