是否有减少完整 Doxygen 覆盖所需的冗余评论数量的技巧？

Question

作为记录我的 C++ 代码库的一部分，我试图获得完整的 Doxygen 覆盖——也就是说，我希望我的所有（数百个）头文件都为它们的所有公共 API 提供格式良好的 Doxygen cmets ，这样我就可以在代码库上运行 Doxygen 而不会看到任何“警告：未记录”警告。

一般来说，这只是浏览和记录内容的问题，但我注意到我在每节课上一遍又一遍地输入相同的文本。例如，我有很多这样的例子：

/** The Foo class represents blah blah blah */
class Foo
{
public:
    /** Default constructor */
    Foo();

    /** Copy constructor
      * @param rhs the object to make this object a copy of.
      */
    Foo(const Foo & rhs);

    /** Destructor */
    ~Foo();

    /** Equality operator.
      * @param rhs the object to compare against.
      * @returns true iff this object and (rhs) are equal.
      */
    bool operator == (const Foo & rhs) const;

    /** Inequality operator.
      * @param rhs the object to compare against.
      * @returns true iff this object and (rhs) are not equal.
      */
    bool operator != (const Foo & rhs) const;

    /** Assignment operator
      * @param rhs the object we should copy our state from
      * @returns a reference to *this
      */
    Foo & operator = (const Foo & rhs);

[...]
}

这些 cmets（通常）对于每个类都或多或少完全相同，因为这些函数/运算符对于每个类几乎总是以完全相同的方式工作。事实上，让操作符或复制构造函数以其他方式运行将是一个值得怀疑的设计模式，因为 C++ 程序员通常希望操作符对每个类都以相同的方式工作。

我的问题是，是否有一些技巧可以告诉 Doxygen 为这些东西自动生成合理的文档（例如，通过某种模板或宏），而不必一遍又一遍地手动输入此文本？这将大大减少我必须输入和维护的文本数量，并且还可以通过允许我删除“no duh”类型的 cmets 来整理我的头文件，以便读者可以更轻松地找到 cmets提供真正的洞察力。

Answer 1

有几个用于复制文档的命令：

\copydoc \copybrief \copydetails

Doxygen 帮助建议使用以下语法：

/*! @copydoc MyClass::myfunction()
 *  More documentation.
 */

这允许您将文档从一个类复制到另一个类。有时我会生成一个纯文档类，它没有被编译为从项目的其余部分中提取文档的标准位置。