web-dev-qa-db-ja.com

ヘッダーに加えて、私のライブラリ内の実装ファイルをdoxygenateする必要がありますか?

私はこのライブラリのDoxygenコメントを書いている最中です。これはヘッダーです-ほとんどはC++ライブラリですが、含まれるのではなくリンクされるコードがいくつかあります。

.h/.hppヘッダーを持つそのコードの場合、ライブラリを「適切に」文書化するために、ヘッダーと同じレベルのコメントの範囲で、.cppファイルにDoxygenコメントも追加する必要がありますか?例えば静的(ファイルスコープ)コードに関するファイルレベルのコメントと詳細な関数レベルのコメントが必要ですか?

PS-関連がある場合(おそらくそうではない): 実際のライブラリへのリンク GitHubで。

1
einpoklum

一般的なルールとして、コメントはコードを保守するときに必要な場所に配置する必要があり、ドキュメントには読者に関連する内容を含める必要があります。したがって、allファイルにはヘッダーと関数レベルのコメントが含まれている必要がありますが、通常はpublicメソッドのみがDoxygen.dによって生成されるユーザードキュメントに含まれている必要があります。

3
Steve Barnes