4

たとえば、私の機能では

//starting code with doxygen documentation
/** The main function. I will now try to document variables within this main function*/
int main()
{
 int arr[]; /** \brief an integer array*/
 .....
 return 0;
}
//end of code

ただし、構成ファイルで「HIDE_IN_BODY_DOCS」変数を「NO」に設定して Doxygen を使用すると、このローカル変数の特定のドキュメントが実行されません。むしろ、関数内の他のコメント行であるかのように、そのビットを取得して、関数のドキュメントと一緒に出力します。

Doxygen を使用してそのようなローカル変数を文書化するにはどうすればよいですか?

4

2 に答える 2

2

関数の本体にコメントを入れて、関数のドキュメントの一部として表示させることができますが、

/** @file */

/** The main function. I will now try to document 
 *  variables within this main function.
 */
int main()
{
  /** an integer array. */
  int arr[];

  /** An endless loop */
  for (;;) {}

  return 0;
}

他の人がすでに指摘しているように、これは一般的に推奨されません。(開発者として) ドキュメントと一緒にソースを読みたい場合は、本文で通常の C コメントを使用することをお勧めします。

/** @file */

/** The main function. I will now try to document 
 *  variables within this main function.
 */
int main()
{
  /* an integer array. */
  int arr[];

  /* An endless loop */
  for (;;) {}

  return 0;
}

に設定INLINE_SOURCESするとともにYES。

于 2013-01-29T19:20:18.703 に答える