java - actionListeners を文書化するためのベスト プラクティス

Question

多数のボタン、テキスト領域、およびテキスト フィールドを含む GUI を使用してプログラムを作成しています。すべて 1 つ以上の actionListeners があり、合計で約 50 個あります。

それぞれに javaDoc レベルのコメントが必要ですか、それとも actionListener メソッドに異なる標準がありますか?

ありがとう

Answer 1

他の人があなたのクラスを使用する可能性は低いため、javadoc を表示しているのはあなただけです。この場合、一歩下がって次のことを考えることが重要です。

• すべての意味を理解できますか?
• 5年後に戻ってきたら、すべての意味を理解できますか?

自分で作業している場合は、必ずしも javadocs を含める必要はありませんが、少なくともそのような簡潔で有益なコメント//progress bar for downloadは、何が何であるかを教えてくれます。すべてのメソッドと操作のセットをもう一度説明する必要はありません。何かがどのように機能するかを忘れた場合に備えて、自分で読めるようにしてください。