Inhaltsverzeichnis:

Wo füge ich Javadoc-Kommentare ein?
Wo füge ich Javadoc-Kommentare ein?

Video: Wo füge ich Javadoc-Kommentare ein?

Video: Wo füge ich Javadoc-Kommentare ein?
Video: Java - Javadoc 2024, Kann
Anonim

Die Javadoc Dienstprogramm lässt Sie stellen Ihre Kommentare direkt neben Ihrem Code, in Ihrem ". Java " Quelldateien. Wenn Sie mit Ihrem Code zufrieden sind und Kommentare , du führst einfach die Javadoc Befehl und Ihr HTML-Stil Dokumentation wird automatisch für Sie erstellt.

Wie fügen Sie dann einem Javadoc Kommentare hinzu?

Beachten Sie Folgendes bei der Verwendung Javadoc-Kommentar hinzufügen (Alt+Umschalt+J): Zu hinzufügen ein Kommentar zu einem Feld positionieren Sie den Cursor auf die Felddeklaration. Zu hinzufügen ein Kommentar zu einer Methode, positionieren Sie den Cursor an einer beliebigen Stelle in der Methode oder auf ihrer Deklaration.

Wozu dienen Javadoc-Kommentare? Javadoc ist ein Tool, das mit JDK geliefert wird und es ist Gebraucht zum Erzeugen Java Codedokumentation im HTML-Format von Java Quellcode, der eine Dokumentation in einem vordefinierten Format erfordert. Es folgt ein einfaches Beispiel, bei dem die Zeilen innerhalb von /*…. */ sind Java mehrzeilig Kommentare.

Wo setze ich Javadoc davon ab?

Sie können JavaDoc-Kommentare an drei verschiedenen Stellen in einer Quelldatei platzieren:

  1. Unmittelbar vor der Deklaration einer öffentlichen Klasse.
  2. Unmittelbar vor der Deklaration eines öffentlichen Feldes.
  3. Unmittelbar vor der Deklaration einer öffentlichen Methode oder eines Konstruktors.

Wie schreibe ich Javadoc-Kommentare in Intellij?

3 Antworten. Wenn Sie /** + eingeben und dann die Eingabetaste oben drücken, wird eine Methodensignatur erstellt Javadoc stummel für dich. Du kannst verwenden die Aktion 'Dokument reparieren Kommentar '. Es hat keinen Standard-Shortcut, aber Sie können ihm in der Keymap die Tastenkombination Alt + Shift + J zuweisen, da dieser Shortcut für nichts anderes verwendet wird.

Empfohlen: