Doxygenはプライベートメンバーと無料の機能についてコメントしていますか？

Question

プライベートメンバーとフリー機能にDoxygenコメントを使用する必要がありますか？私はJavaの世界から来て、プライベートメンバーにJavadocを追加したことはありません。これはC++の世界で受け入れられる練習ですか？

Answer 1

私はそれがかなり言語に依存しない問題だと思います。あなたが文書化したがっているメンバーを文書化します。

Answer 2

ドキュメントの対象読者によって異なります。それが公的リリースの場合は、いいえ、私的な変数と内部変数について知る必要はありません。

内部使用の場合は、はい、プライベート変数とフリー関数の使用方法を確実に知る必要があります。

Answer 3

プライベート機能を文書化することができます。@internalを使用して、パブリックおよびデベロッパーのドキュメントを提供しています。

また、実装がユーザーから隠されている私的実装の方法も使用します。