[Auch Anfänger können es schaffen! ] Wie man Javadoc schreibt
1. Vorkenntnisse
Oder
Nach Vorkenntnissen ist der Inhalt des obigen Links erforderlich.
2. Was ist Javadoc?
―― Javadoc ist eine von Sun Microsystems entwickelte Computersoftware, die aus Java-Quellcode HTML-API-Spezifikationen generiert.
- Javadoc-Kommentare sind "Kommentare" zwischen "/ *" und " /".
3. Wie schreibe ich Javadoc und erstelle Dokumentation
Sample.java
/**
* @Autor Autorenname
* @version x.x.x
*/
/**
*Javadoc Kommentar Hauptklasse
*/
public class Sample {
/**
*Hauptmethode
* @param args nicht verwendet
*/
public static void main(String[] args) {
//Anzeige der Zeichenkette
System.out.println("JavaDoc-Beispiel");
}
}
--Kopieren Sie die obige Anweisung, geben Sie "S-JIS" als Zeichencode an, speichern Sie den Dateinamen als "Sample.java" und führen Sie "javadoc -d html Sample.java" an der Eingabeaufforderung aus. ↓ ↓
$ javadoc -d html Sample.java
- Das Ergebnis ist wie folgt.
- Bestätigen Sie, dass der Ordner "html" erstellt wurde.
--Öffnen Sie index.html im Ordner html.
- Der Browser startet und Sie sehen
Sample.html.
- Wenn es wie das Bild angezeigt wird, ist es erfolgreich.
4. Verwandte
- [Neueste] So erstellen Sie eine Java-Umgebung unter Ubuntu
- [Auch Anfänger können das! ] So erstellen Sie eine Java-Umgebung unter Windows 10 (JDK14.0.1)
- [Auch Anfänger können das! ] So installieren Sie Eclipse unter Windows 10 (Java-Umgebungskonstruktion)
Recommended Posts