Kommentare in Java

Kommentare sind in Java , wie in den meisten anderen Programmiersprachen, Zeichen, die während der Programmausführung ignoriert werden. So können Sie dem Programm beliebig viele Kommentare hinzufügen, ohne befürchten zu müssen, dass es dadurch größer wird. Kommentare werden verwendet, um die Feinheiten eines bestimmten Codeblocks, einer bestimmten Methode oder einer bestimmten Klasse zu beschreiben. Sie können sie auch verwenden, wenn Sie Nachrichten für Programmierer hinterlassen möchten, die in Zukunft mit diesem Code arbeiten werden. Oder für Ihre eigenen Notizen.

Möglichkeiten, Kommentare hervorzuheben

Java bietet zwei Möglichkeiten, Kommentare im Text hervorzuheben.

Implementierungskommentar (Codekommentar)

1. Eine Zeile kommentieren

   Dies ist der am häufigsten verwendete Kommentartyp. Um einen solchen Kommentar zu schreiben, müssen Sie zwei Schrägstriche verwenden //. In diesem Fall beginnt der Kommentar unmittelbar nach den Zeichen //und dauert bis zum Ende der Zeile.

   System.out.println("Hello, Java world!");
   // наш комментарий

2. Einen Textblock kommentieren

   Wenn Sie längere Kommentare benötigen, können Sie jede Zeile mit Symbolen beginnen. Obwohl es praktischer ist, Kommentarblöcke auf Trennzeichen /*und zu beschränken */.

   /*
    Пример простой программы на Java
   */
   
   public class SampleProgram
   {
    public static void main (String [] args)
    {
    System.out.println("Hello, Java world!");
    }
   }

   Wir sollten nicht vergessen, dass durch Symbole getrennte Kommentare in der Java-Sprache /*nicht */verschachtelt werden können. Dies bedeutet, dass ein Codeabschnitt nicht einfach dadurch deaktiviert werden kann, dass man ihn mit „ /*and“ umgibt, da der zu deaktivierende Code selbst „ and“ */-Trennzeichen enthalten kann ./**/

Kommentar dokumentieren

Um Methoden, Variablen oder Klassen zu dokumentieren, wird eine spezielle Methode der Texthervorhebung verwendet. Dies geschieht mit /**und */. In diesem Fall beginnt jede Zeile des kommentierten Textes mit *. Wenn eine Methode dokumentiert wird, ist es üblich, ihre Argumente und ihren Rückgabewert zu beschreiben.

/**
* Метод возвращает максимальное Bedeutung
* из трех переданных аргументов
* @param a - первый параметр
* @param b - второй параметр
* @param c - третий параметр
* @return - максимальный из параметров
*/
public int max(int a, int b, int c) {
   return Math.max(Math.max(a, b), c);
}

Was gibt es sonst noch zu lesen? Zum Beispiel dieses Material: Kommentare in Java: Nicht alles ist so einfach . Oder ein Vortrag aus der Java Syntax Pro-Quest über Kommentare.