Hinzufügen von Java-Dokumentation zu einem Programm in Netbeans

Question

Wie kann ich Java-Dokumentation zu meinem Java-Programm mit Netbeans hinzufügen?

Answer 1

Geben Sie in der Zeile über jeder Methode oder Klasse/** ein und drücken Sie die Eingabetaste.
Geben Sie Ihre Kommentare dazwischen ein.

Answer 2

Sie haben eine Reihe von Optionen:

• Rechtsklick auf einen Quellcode-Paket und wählen Sie Extras> Analysieren Javadoc. Dadurch wird Javadoc allen Methoden hinzugefügt.
• Geben Sie/** in die Zeile vor einer Klassen-, Methoden- oder Felddeklaration ein und drücken Sie die Eingabetaste. Standard-Javadoc wird für diese Methode erstellt.
• Platzieren Sie den Cursor innerhalb einer Klasse oder Methodendeklaration. Drücken Sie Alt + Enter, und wählen Sie dann "Create Javadoc"

Answer 3

Verwenden Sie auch die

@param 

Tag-Parameter in einem Javadoc angeben:

---

/** 
    * 
    * A method 
    * 
    * @param abc Used to do nothing 
    */ 
public static void doNothing(int abc) { 
    System.out.println(abc); 
} 

---

Sie können auch die Alt + Eingabetaste in Netbeans verwenden, um das Javadoc automatisch mit allen Parametern einzufügen Beachten Sie jedoch, dass diese Methode/dieses Feld nicht privat sein kann.