11

私は Doxygen を使用してコードベースを文書化していますが、関数への引数をオプションとして宣言するためのキーワードがあるかどうか疑問に思っていました。何かのようなもの:

/*!
\fn int add(int a, int b=0)
\brief adds two values
\param a the first operand
\param \optional b the second operand.  Default is 0
\return the result
*/

これはあるべきもののようですが、どこにも見つかりませんでした。実際のオプションはありますか、それとも説明にメモする必要がありますか?

4

3 に答える 3

12

あなたの質問に答えるには: いいえ、そのようなことはありません。

しかし、私はそのようなものがあるべきだというあなたの意見には同意しません。結局、関数宣言はそのドキュメントと一緒に表示されるので、誰もがそれbがオプションであり、デフォルトの引数が何であるかを知ることができます. また、\fn の使用を推奨していない\fndoxygen のドキュメントを参照してください。

于 2013-01-10T16:07:04.757 に答える
0

\param foo [in,out,opt,banana] をカンニングして使用します foo の目的を説明してください。

任意のオプションを追加できます!

于 2022-03-03T03:04:47.967 に答える
0

あなたが望むものはDoxygenによって提供されていません.説明に手動でメモする必要があります.

于 2013-01-10T16:07:05.073 に答える