Bei Java-Annotationen gibt es insgesamt 3 Annotationsmethoden
1. Zeilenkommentare
Es kann nur eine Inhaltszeile kommentiert werden und wird an Stellen verwendet, an denen der Inhalt der Kommentarinformationen gering ist.
Die Tastenkombination in IDEA lautet: Strg + /
Tastenkombination Einmal drücken, um einen Kommentar abzugeben, erneut drücken, um den Kommentar abzubrechen.
// Inhalt kommentieren
2. Mehrzeiliger Kommentar, Blockkommentar
Die Tastenkombination in IDEA lautet: Strg + Umschalt + /
Tastenkombination Einmal drücken, um einen Kommentar abzugeben, erneut drücken, um den Kommentar abzubrechen.
/*
Inhalt beachten
Inhalt beachten
Inhalt beachten
*/
3. Kommentare zur Dokumentation
Eingefügt zwischen „/**“ und „*/“ kann es auch mehrere Zeilen kommentieren. Es wird im Allgemeinen für Klassen, Methoden und Variablen verwendet, um deren Funktionen zu beschreiben. Wenn Sie nach dem Kommentieren mit der Maus über die Klasse und Variable fahren, wird automatisch der Inhalt unseres Kommentars angezeigt.
Die Tastenkombination in IDEA lautet: /**+Enter.
Anmerkung zum Klicken auf Tastenkombinationen. Nur diese annotierte Methode kann in das Javadoc-Dokument geschrieben werden
/**
*Inhalt beachten
*..........
*/
Beispiele für die oben genannten drei Anmerkungen:
public class Demo {
/**
* @param args 这是一个实例
* @auther 作者名
* @Date 时间
*/
public static void main(String[] args) {
System.out.println("Hello world!"); // 输出Hello world!
/*
这是刚开始的代码
*/
}
}
4. Einige Beschreibungen der Tag-Syntax für Javadoc-Kommentare (Dokumentkommentare).
Einige Erläuterungen zur Javadoc-Kommentar-Tag-Syntax. (Sie können @ eingeben und Alt + / (Vervollständigungstaste) hinzufügen.)
@author Autorenname. Verfügbar in: Klassenanmerkungen.
@deprecated Beschreibung einer Klasse oder Methode Diese Klasse oder Methode wird nicht empfohlen und führt zu veralteten Warnungen
@Exception Eine Beschreibung der Ausnahme, die ausgelöst werden kann. Verfügbar in: Methodenanmerkungen.
@note stellt Anmerkungen dar, Dokumente, die Quellcode-Lesern zugänglich gemacht werden
Beschreibung des @param-Parameters. Verfügbar in: Methodenanmerkungen.
@return Beschreibung des Rückgabewerts. Verfügbar in: Methodenanmerkungen.
@remark weist auf Kommentare und Dokumentation hin, die Client-Programmierern zugänglich gemacht werden
@see Erzeugt einen Hyperlink von „siehe Eintrag von xx“ im Dokument, dem Folgendes folgen kann: „Klassenname“, „vollständiger Klassenname“, „vollständiger Klassenname#Methode“. Verfügbar für: Klassen-, Methoden- und Variablenanmerkungen.
@since gibt an, dass diese Funktion seit dieser Version verfügbar ist
@version-Versionsinformationen. Verfügbar in: Klassenanmerkungen.
Weitere Anweisungen finden Sie unter: Java-Dokumentationskommentare ( java-Dokumentationskommentare_java-dokumentationskommentare Label_Western Jin's no1's Blog-CSDN-Blog )
5. Vorsichtsmaßnahmen
Kommentare Der Inhalt von Kommentaren sollte einfach, klar und präzise sein, um Mehrdeutigkeiten in Kommentaren zu vermeiden. Falsche Kommentare sind nicht nur nutzlos, sondern auch schädlich.