任何自动生成doxygen注释块的软件？

Question

我正在开发一个大型的C++程序,现在我决定用Doxygen来记录它.有很多类,方法,函数,宏等.因此,我正在搜索将扫描我的源代码树并在每个"可记录项目"上插入Doxygen注释块的软件,以便我稍后编辑它们并添加方法描述等详细信息.

有这样的软件吗？

我使用Code :: Blocks IDE在GNU/Linux下,因此不需要Visual Studio插件.

Answer 1

我在这里很困惑.

自动生成评论的目标是什么？

评论意味着带来额外的价值:

/**
 * \brief: finds the person based on its name
 * \param: name, the name of the person
 * \result: the person
 */
Person findPerson(Name name);

只是代码混乱阻塞了我宝贵的屏幕空间.而这大约相当于可自动生成不幸......注意尤其是我没有的,如果有史以来功能没有找到人,这肯定是很可能发生的事情的想法:它中止？抛出？(什么......？)返回一个默认的构造对象？

另一方面:

///
/// Try an exact match approach to begin with
/// Uses the double metaphone algorithm
///   if none was found as we have
///   a western european clientele
///
Person findPerson(Name name)
{
}

更有趣!

• 现在我知道这个奇怪的集合是if什么似乎正在进行某种声音识别......
• 我知道它的名字,所以我可以在互联网上查找它的实现(功能)
• 而且我知道为什么它被选中,因此我应该重新评估它的用途(适合西欧客户,所以如果我们在阿拉伯市场上发展它就需要适应......)

不幸的是,这不会自动生成.

Answer 2

您还可以设置 Doxygen 来提取未记录的项目 - 这可能会执行您想要的操作，而无需在代码中添加任何注释块。

之后，您可以创建模板/宏（取决于您的 IDE）来为每种类型的项目创建预格式化的块，同时慢慢地逐一完成记录项目的代码。

[编辑] 如果您使用的是 Visual Studio，则可以对文件中的类和其他构造进行一些内省，这可能会有所帮助。或者看看Doxycomment - 它可能是您想要的一些内容。