[Super unbesiegbare und detaillierte Java-Notizen von Han Shunping] Vom Anfänger bis zum Experten --- Kommentare

1. Einführung in Anmerkungen

   Der zum Kommentieren und Erklären des Programms verwendete Text ist ein Kommentar. Kommentare verbessern die Lesbarkeit (Lesbarkeit) des Codes; Kommentare sind gute Programmiergewohnheiten, die ein Programmierer haben muss. Organisieren Sie Ihre Gedanken zunächst durch Kommentare und verwenden Sie dann Code, um sie wiederzugeben. In Java gibt es drei Arten von Anmerkungen:

2. Kommentartyp

1. Einzeiliger Kommentar //: // Kommentartext
2.  Mehrzeilige Kommentare /* */: /* Kommentartext */
3.  Kommentare zur Dokumentation /** */

PS: Wählen Sie den zu kommentierenden Teil aus, drücken Sie Strg + Umschalt + /, um einen Kommentar abzugeben, oder schließen Sie die Eingabe ab /** + Tab, um den Vorgang automatisch abzuschließen

---

• Einzeiliger Kommentar:
• Angezeigt durch //, Kommentarinhalt nach // hinzufügen.

• // 这是一个单行注释，用来解释该行代码的作用
  int a = 10; // 这也是一个单行注释，用来解释该语句的作用
  

• Mehrzeilige Kommentare:
• Angezeigt durch /.../ können dem Kommentar mehrere Inhaltszeilen hinzugefügt werden. (kann nicht verschachtelt werden)

• /* 这是一个多行注释，
     用于解释以下代码的作用 */
  int a = 10; 
  

• Dokumentationshinweise:
• Der Anmerkungsinhalt kann von Javadoc, einem vom JDK bereitgestellten Tool, analysiert werden, um eine Dokumentation für das Programm in Form einer Webseitendatei zu generieren, die normalerweise in der Klasse geschrieben wird
• Dargestellt durch /**...*/, wird zum Generieren der API-Dokumentation verwendet. Dokumentationskommentare enthalten Beschreibungen und Parameter von Klassen, Methoden usw.

• /**
   * @author choclin
   * @version 1.0
  
   */
  	public class  Comment02{
  		public static void main(String[] args){
  			System.out.println("读书");
  		}
  	}

  D:\Programme\Java\Javacode>javadoc -dd:\\temp -author -version Comment02.java

 

Javadoc-Tag

Etikett	beschreiben	Beispiel
@Autor	Identifizieren Sie den Autor einer Klasse	@author choclin
@veraltet	Gibt eine abgelaufene Klasse oder ein abgelaufenes Mitglied an	@deprecated choclin
{@docRoot}	Gibt den Pfad zum aktuellen Dokumentstammverzeichnis an	Verzeichnispfad
@Ausnahme	Kennzeichnet eine von einer Klasse ausgelöste Ausnahme	Erklärung des @Exception-Ausnahmenamens
{@inheritDoc}	Von der direkten übergeordneten Klasse geerbte Anmerkungen	Erbt einen Kommentar von der unmittelbaren Oberklasse.
{@Verknüpfung}	Fügen Sie einen Link zu einem anderen Thema ein	(@Linknamentext)
{@linkplain}	Fügen Sie einen Link zu einem anderen Thema ein, aber der Link zeigt einfachen Text in Holzschriftarten an	Fügt einen Inline-Link zu einem anderen Thema ein.
@param	Beschreiben Sie die Anzahl der Sätze einer Methode	Erklärung des Parameternamens @param
@zurückkehren	Beschreiben Sie den Rückgabewerttyp	@return-Erklärung
@sehen	Geben Sie einen Link zu einem anderen Thema an	@see Anker
@serial	Beschreibt eine Serialisierungseigenschaft	@serial Beschreibung