Should Methode / Klasse Kommentare durchweg nur eine Notwendigkeit Basis angewendet oder werden?

Question

Aus Gründen der Einheitlichkeit habe ich immer Kommentare angewandt (in Form eines JavaDoc) auf alle Methoden und Klassen, auch wenn sie einfach sind Getter und Setter-Methoden oder sehr kleine Wrapper-Klassen. Aber ich bin bemüht, auch zu schreiben, selbsterklärend Code, der oft Kommentare überflüssig macht; das heißt Schreib Kommentare nur bei Bedarf (und bevor Sie das tun, versuchen, den Code neu zu schreiben, so dass Sie den Kommentar überhaupt nicht brauchen). Daher erscheinen diese beiden Ansätze miteinander widersprüchlich sein.

So sollten Kommentare, die eine Methode oder Klasse beschreiben in einer konsistenten Art und Weise angewendet werden, oder sollten solche Kommentare nur geschrieben werden, wenn Bedeutung nicht vollständig von der Definition klar ist?

Answer 1

Eine einfache Lackmus-Test wäre zu prüfen, ob die Klasse mehr Kommentare als der Code hat. Wenn yest dann bedeutet es, dass Ihr Code zu komplex und schwer zu Verwendung für jedermann.

So ist es am besten selbsterklärend Code zu schreiben. Auch gibt es keine Notwendigkeit, um Kommentare zu schreiben für Dinge, die offensichtlich wie Getter und Setter sind.

Also habe ich mit solche Kommentare nur dann gehen, wenn geschrieben Bedeutung nicht vollständig von der Definition klar.

Answer 2

verwenden I-Code erstellen für jede Methode, aber jetzt habe ich nur Dokumentation erstellen, wenn die Bemerkungen mehr Informationen als der Code selbst hinzufügen.

Hier ist eine Frage zu einem ähnlichen Thema mit vielen Antworten. Da der Code entwickelt sich gibt es eine Chance, dass die Aktualisierung der Dokumentation wird „vergessen“. Mit Bezug auf die Frage in der Verbindung schlecht Dokumentation ist schlimmer als gar keine Dokumentation überhaupt.