Kommentar oder InlineDoku?

[Dagobert]

Sollte man in Java besser Kommentare benutzen

// bluPP

oder sollte man lieber InlineDokumentationen benutzen?

/**
* bluPP²
*/

 

[André Uhres]

Deine beiden Beispiele machen die Antwort leicht:
Die erste Variante für eine einzelne Zeile und die zweite für einen Zeilenblock

 

[Dagobert]

ja das eine ist nur ein einfacher kommentar (einzeilig) das andere kann mehrzeilig sein

aber das /** wird im manchen editoren wie BlueJ beim Interface-Dokumentation anzezeigt... der einfache kommentar net...

 

[Beni]

Kommentar und Dokumentation haben unterschiedliche Einsatzgebiete, dementsprechend kann man beide benutzen:

Kommentare sind für Entwickler gedacht, die den Quellcode direkt vor sich haben, und den Quellcode verstehen wollen. Hier beschreibt man Details die den normalen Benutzer nicht interessieren würden, z.B. wieso man an innerhalb der Methode x eine LinkedList und keine ArrayList gewählt hat, wieso die komische Bitoperation an Stelle y tatsächlich funktioniert, ...

Dokumentation hingegen ist für diejenigen gedacht, die deine Klassen benutzen möchten. Sie gibt den grossen Überblick, erklärt welche Parameter eine Methode benötigt, für welchen Zweck eine Klasse gedacht ist, auf was man bei der Implementation eines Interfaces achten sollte...

 

[Dagobert]

ok danke für die info =)