3

Doxygen は非常に優れた C++ コード ドキュメンテーション ツールです。クラス内の関連する多数のメソッドをグループ化し、それらに意味のあるコメントを与える機能があるかどうか疑問に思っています。例えば:

class A : public B
{
public:
    //// Begin group: Methods to implement class B's interface.

    //! ...
    void b1();

    //! ...
    void b1();

    //// End group

};

グループ情報は、doxygen によって生成されたクラス ドキュメントに表示されます。ありがとう。

4

1 に答える 1

3

@name タグを使用して、同様の機能にアクセスできます。例を見てみましょう。それは簡単です。

/**
 * @name Appends data to the container.
 *
 * @param tag Name of the data entry
 * @param value Data value
 */
//@{
/**
 * @brief Documentation for this overload
 */
void append(const std::string & tag, bool value);

/**
 * @brief Documentation for this overload
 */
void append(const std::string & tag, int8_t value);

void append(const std::string & tag, int16_t value);
void append(const std::string & tag, int32_t value);
//@}

次の出力が生成されます。 ここに画像の説明を入力

于 2013-08-25T20:17:53.107 に答える