Java Doc-フィールドも文書化されますか？
これは本当に簡単な質問ですが、奇妙なことに、明確な答えを得るのは難しいと思います。
フィールドをどのように扱いますか？これは有効ですか？
/**
* Keeps track of all usernames in the system.
*/
private List<String> usernames = new ArrayList<>();
または、ドキュメンテーションツールによって無視されているため、次のようなことを行うのが最善でしょう。
//Keeps track of all usernames in the system.
private List<String> usernames = new ArrayList<>();
（私が見たものから）、ドキュメントにはメソッド、コンストラクター、およびクラスのみが示されているので、プログラマーは通常フィールドで何をしますか？
プライベートフィールドは通常ドキュメントツールによって無視されるため、APIをサードパーティに出荷すると、プライベートフィールドに関するドキュメントを表示できなくなります（ただし、プロジェクトのドキュメント生成フェーズでドキュメントにプライベートフィールドを含めます）。
そうは言っても、私はJavaDocを使用してプライベートフィールドを文書化することをお勧めします。
- 他のドキュメントの残りに準拠します。
- ほとんどのIDEはJavaDocを抽出し、さまざまなオブジェクトプロパティにアクセスしようとすると表示されます。これにより、特定の変数の目的を確認するためにコードを回る時間を節約できます。
- プライベートフィールドのドキュメントをドキュメントに含めたい場合、すべての作業は既に完了しています。