2

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

4

3 に答える 3

1

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

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

于 2010-12-12T19:57:32.243 に答える
0

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

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

于 2012-08-23T12:12:32.790 に答える
0

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

于 2010-12-12T19:24:58.280 に答える