Doxygenを使用してコードベースを文書化していますが、関数の引数をオプションとして宣言するためのキーワードがあるかどうかは疑問でした。次のようなものがあります:Doxygen - パラメータをオプションで宣言する
これは存在するはずですが、どこでも見つけることができませんでした。実際の選択肢がありますか、または説明に記入するだけですか?
Doxygenを使用してコードベースを文書化していますが、関数の引数をオプションとして宣言するためのキーワードがあるかどうかは疑問でした。次のようなものがあります:Doxygen - パラメータをオプションで宣言する
これは存在するはずですが、どこでも見つけることができませんでした。実際の選択肢がありますか、または説明に記入するだけですか?
質問に答えるには:いいえ、そんなことはありません。
しかし、私はそのようなものがあるべきであるというあなたの意見を共有しません。結局のところ、関数の宣言はそのドキュメントと共に表示されるので、誰もがb
がオプションで、デフォルトの引数は何であるか分かります。 \fn
については、doxygenのドキュメントdiscouraging the use of \fnを参照してください。
あなたが望むのはDoxygenによって提供されていません - 説明の中に手動で書き留めておかなければなりません。
お役立ち情報グローバル関数のために '\ fn'の代わりに何を使うべきですか? – ewok
何もない - 関数(-declaration)の直前に文書化コメントを置いてください。投稿されたリンクのように(最初の段落) –