Doxygen でパラメータを参照する正しい方法は何ですか? 質問する

Doxygen でパラメータを参照する正しい方法は何ですか? 質問する

関数に関する次の Doxygen ドキュメントがあります:

/**
  @brief Does interesting things

  @param[in]  pfirst The first parameter: a barrel full of monkeys

  @pre
    "pfirst" must have been previously passed through BarrelFiller()
*/

pfirstパラメータであり、前提条件で参照されることに注意してください。

ここでは、テキストの残りの部分から区別するために引用符で囲んでいます。ただし、Doxygen がコマンドを強調表示し、できればパラメータ定義にリンクするようにすると便利です。これを行う方法はありますか?

これがデフォルト設定(またはそれに若干の変更を加えたもの)のみを使用して実行されると特に便利です。

ベストアンサー1

Doxygenはコマンドを提供する\p次の単語が関数のパラメータであることを示します。次のように使用します。

... the \p x and \p y coordinates are used to ...

デフォルトでは、タイプライター フォントを使用して表示されると思います。現時点では自動リンク機能は提供されていないと思いますが、将来的には提供される可能性があります。

関連するコマンドがあります。\aメンバーの引数をマークアップするために使用されます。デフォルトでは、テキスト内で強調表示されます(<em>arg</em>

さまざまなDoxygenに関する詳細情報は、特殊コマンドリファレンス

おすすめ記事