c++ - プライベートメンバーと無料機能のDoxygenコメント?

Question

プライベート メンバーと無料関数に Doxygen コメントを使用する必要がありますか? 私は Java の世界から来ましたが、プライベート メンバーに Javadoc を追加したことはありません。これは C++ の世界で受け入れられる慣行ですか?

Answer 1

ドキュメントの対象読者によって異なります。パブリック リリースの場合は、いいえ、プライベート変数と内部変数について知る必要はありません。

内部で使用する場合は、もちろん、プライベート変数とフリー関数の使用法について知る必要があります。

Answer 2

プライベートな関数を文書化することができます - 私たちは@internal公開文書と開発者文書を提供するために使用しています。

また、実装がユーザーから隠される非公開の実装プラクティスも使用します。

Answer 3

それはほとんど言語に依存しない問題だと思います。文書化したいメンバーを文書化します。