72

関数に関する次の 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 がコマンドを強調表示し、できればそれをパラメーター定義にリンクするような方法でこれを行うとよいでしょう。これを行う方法はありますか？

これがデフォルト構成 (またはそのわずかな変更) のみを使用して発生する場合は特に素晴らしいでしょう。

4

3 に答える 3

82

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

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

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

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

さまざまな Doxygen特殊コマンド リファレンスに関する詳細情報を見つけることができます。

于 2013-03-16T22:16:55.510 に答える
0

参照するパラメーターの前に「#」記号を使用します。

#pfirst must have been previously passed through BarrelFiller()

（doxygenマニュアルで）

于 2017-05-05T20:48:43.460 に答える