2

コードで Doxygen コメントを使用して、生成されたドキュメントの関数の説明を補足する箇条書きリストを作成したいと考えています。たとえば、次のスニペット コード:

/**
 * Function x
 */
void function (void) {
/// List:
/// - comment A
;
;
/// + comment B
;
;
/// * comment C

}

そのようなリストを生成する必要があります:

List:
- A
  - B
    - C

残念ながら、Doxygen は同じ関数のコメント ブロック間でインデント レベルを維持していないようです。その回避策はありますか?

ありがとう

4

2 に答える 2

4

過去数時間調査した結果、不連続な doxygen コメントにインデントされたリストは不可能であるという結論に達しました。

インデントされたリストをブロック コメントで簡単に機能させることができました。

/**
-# Item 1
    -# Subitem 1
    -# Subitem 2
-# Item 2
*/

単一行のコメントに切り替えても、引き続き機能しました。

/// -# Item 1
///     -# Subitem 1
///     -# Subitem 2
/// -# Item 2

1 行のコメントの間にコードを追加すると、doxygen はサブ項目のインデントを停止しました。

于 2014-01-29T19:59:33.297 に答える
2

HTML形式を使用して実際に行うことができます

//! <ul><li> Entering a condition:<ul>
if (xx)
{
    //! <li> something
    C=A+B;

    //! <li> something else
    D="lol";
}
//! </ul></ul>
于 2015-09-15T09:22:02.993 に答える