プリミティブ型に関するJavaの規則は何ですか？適切な名前を付けた場合、各プリミティブ型を文書化する必要がありますか？
/**
* This is the variable that handles whether or not a person has turned on a light.
*/
private boolean toggleLight = false;
それは絶対的なやり過ぎのように私には思えます。誰かが情報源を持っているか、単なる以前の知識を持っているなら、それは大いにありがたいです。
何よりも、それはあなたが働いているチーム、異なる会社、そしてプロジェクトでさえ異なる「基準」を持っているかどうかに依存すると思います。特に変数はプライベートになる傾向があるので、私は個人的にすべての変数にコメントすることを気にしません。変数がパブリックの場合は、Javadocに表示されるようにコメントします。
メソッドについても同じことが言えます。プライベートメソッドの場合は、明らかな場合はコメントしません。また、セッターとゲッターにはコメントせず、ロジックを含むメソッドのみにコメントします。
私が言ったように、それは一般的にあなたがコーディングしているチームに依存します。
これは、プリミティブ型とは何の関係もありません。あなたは自分で良い例を挙げます：名前toggleLightは自明ではありません。コメントを追加し、さらに良いことに、名前を変更します。
私が大好きなもう1つの例float weightは、この重量はどの単位であるかということです。それは質量のように重量でさえありますか、それとも重要性のように重量です。
これはJavaとは何の関係もありません。プログラム固有の言語ではなく、企業固有のものである必要があります。チームがすべての変数を文書化することを決定した場合、これが当てはまります。一般に、各メソッドを文書化するのは良いことです。特にIDEの公開メソッドは、それらを操作しながらドキュメントを表示します。一部の企業は、プライベートメソッドも文書化することを決定します。これは、メソッドが大きく、名前が説明するのに十分でない場合に特に必要になる可能性があります。メソッドが行うこと。
XMLタグに従ってドキュメントの特定のパターンを読み取るドキュメント生成ツールが多数あるため、ドキュメントの形式を検討することが重要です。