Kommentare sind ein mächtiges Werkzeug. Sie können verwendet werden , um ganze Application Programming Interface (API) Dokumentationen mit Tools wie javadoc erzeugen , geben kleine Hinweise in kniffligen Teile des Codes , oder einfach nur beschreiben , was der Code etwa zu tun ist, werden. Wenn Sie Kommentare in Java-Code zu verlassen , können Sie zeigen auch ein Leser , der nicht weiß , was genau die Sprache der Code tut. Anleitung
1

Lassen kurze , einzeilige Kommentare schnell etwas vor einer kleinen Gruppe von Zeilen sagen . Kleine Kommentare Umriss , was gerade im Allgemeinen getan " Brocken ". Ein Programmierer oft schreibe diese Kommentare zuerst und gehen Sie zurück in den Code später zu füllen, ihm zu helfen, seine Vorstellung davon, wie der Code wird vor zu arbeiten, um es zu schreiben , sowie die Identifizierung irgendwelche Fehler in der Logik , bevor das Schreiben des Codes zu zementieren.
2

Kennen Sie das Format für das Verlassen einzeilige Kommentare . . "; ( Example.com" , 80) ;//Fordern Sie die files.write ("GET /HTTP /Sie werden durch " //" " s.connect //zum ServerSocket s = new TCPSocket ( ) Schließen Sie ", bemerkte 1.0 \\ r \\ n \\ r \\ n "); String response = s.read () ;//War die Anfrage erfolgreich int code = get_code (Antwort) ; ? if ( code = 200) return -1 ;//Laden die filedownload_file (s); " "
3

Nutzungsbedingungen mehrzeiligen Kommentaren , wenn Sie mehr zu sagen , als in einer einzigen Zeile passen. Multi -line Kommentare sind in der Regel an der Spitze der Methoden beschreibt allgemeine Funktion gefunden , wie es funktioniert und welche Parameter es dauert. Sie sind auch manchmal in lokalisierten Teile des Codes der Programmierer hatte Probleme mit oder denkt Haftbefehl eingehende Diskussion gesehen .
4

Beachten Sie die allgemeine Format mehrzeilige Kommentare . Per Konvention beginnt jede Zeile mit einem Sternchen versehen. Die einzigen spezifischen Format Anforderungen sind, dass der Kommentar mit /* und endet mit * /beginnt . "" /* Dieser Teil war wirklich hart. Ich musste * hacken diesen Wert mit den anderen passen. * Vielleicht werde ich wieder in diesem Code * einen besseren Weg , dies zu tun , aber für * jetzt das funktioniert, aber es ist nicht hübsch. * /""
5

wissen das Format Javadoc Kommentare . Sie beginnen mit /** und Meta-Tags enthalten , die wie folgt aussehen @ . Javadoc Kommentare werden vor allem Methoden gefunden. "" /*** Berechnet die Steigung einer Geraden . ** @ Autor Jack Smith * @ param p1 Erster Punkt , die die Zeile beschreibt * @ param p2 zweite Punkt, die Linie beschreibt * @ return Steigung der Linie als float * /""