6

初めてdoxygenを使用しようとしています。

私はいくつかのCライブラリと構造を文書化するためにそれを使用しています。

正しいタグを使用すると思いますが、ドキュメンテーションは定義マクロに関する限りにおいてのみ優れていますが、関数タグ ( \fn) は完全に無視されています。タグ付けされたコメントの例を以下に添付します。

`/*!    \file   cab.h`

    \author dan
    \date   20/12/2013
    \brief  cab

`*/
   /*! \def NOT_SPECIFIED`

     \brief Constant value that indicates the not specification of a parameter
  ` */`

   `#define NOT_SPECIFIED 0`

    /*! \fn         cab_create
     \brief     allocates the memory space and resources for the CAB
     \param     c cab to create
     \param     dim_buf size of the data contained in each buffer
     \param     maximum number of buffer
     \param     protocol used to handle priority inversion 
     \param     ceiling value of the ceiling,
     \return    1 if it completes successfully, -1 otherwise
    */`
    int cab_create(cab *c, int dim_buf, int max_buf, int protocol, int ceiling);
4

1 に答える 1

10

\fnドキュメントには、コメントが関数宣言の直前に配置されていない場合にのみ必要であることが明確に示されています。

コメント ブロックが関数の宣言または定義の前にある場合、このコマンドは省略できます (冗長性を避けるため)。

したがって、行全体を削除するだけで機能し\fnます。

アップデート：

ちなみに、\fileその後にファイル名を付けるべきではありません.

ファイル名が省略された場合 (つまり、\file の後の行が空白のままになっている場合)、\file コマンドを含むドキュメント ブロックは、それが配置されているファイルに属します。

ファイル名を指定すると、ファイル名が変更された場合に手動で更新する必要があり (これは実際に行われます)、更新を忘れる可能性があります。ファイル名を指定しない方が簡単で、常に最新の状態になります。

于 2013-12-30T15:52:32.320 に答える