c++ - 有没有自动生成 doxygen 注释 block 的软件？

Question

我正在开发一个大型 C++ 程序，现在我决定用 Doxygen 来记录它。有大量的类、方法、函数、宏等等。因此，我正在寻找能够扫描我的源代码树并在每个“可记录项目”顶部插入 Doxygen 注释 block 的软件，以便我稍后对其进行编辑并添加方法描述等详细信息。

是否存在这样的软件？

我在 GNU/Linux 下使用 Code::Blocks IDE，所以不需要 Visual Studio 插件。

Answer 1

我在这里很困惑。

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

评论旨在带来额外的值(value):

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

只不过是代码困惑阻塞了我宝贵的屏幕空间。不幸的是，这差不多是可以自动生成的……特别注意，我不知道如果函数找不到人会发生什么，这看起来很可能:它会中止吗？ throw ？ (什么...？)返回一个默认构造的对象？

另一方面:

///
/// 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 集合是什么了，它似乎在执行某种声音识别...
• 我知道它的名字，所以我可以在 Internet 上查找它以检查它的实现(功能)
• 而且我知道为什么选择它，因此我应该在什么时候重新评估它的使用(适合西欧客户，所以如果我们在阿拉伯市场开发它需要适应...)

不幸的是，这不会自动生成。