Inhaltsverzeichnis:

Wie schreibt man ein Javadoc?
Wie schreibt man ein Javadoc?

Video: Wie schreibt man ein Javadoc?

Video: Wie schreibt man ein Javadoc?
Video: Java - Javadoc 2024, November
Anonim

Javadoc-Codierungsstandard

  1. Javadoc schreiben als Quellcode gelesen werden.
  2. Öffentlich und geschützt.
  3. Verwenden Sie den Standardstil für die Javadoc Kommentar.
  4. Verwenden Sie einfache HTML-Tags, kein gültiges XHTML.
  5. Verwenden Sie eine einzelne

    Tag zwischen den Absätzen.

  6. Verwenden Sie eine einzelne
  7. Tag für Elemente in einer Liste.
  8. Definiere einen druckvollen ersten Satz.

Wie erstellt man in dieser Hinsicht ein Javadoc?

Version der Klasse, Schnittstelle oder Aufzählung bereitstellen. Wählen Sie „Generieren“ JavaDoc ”-Option aus dem Projektmenü und ein Assistent wird angezeigt. Geben Sie den Ort für die JavaDoc Datei auf Ihrem Computer, standardmäßig im Laufwerk C. Wählen Sie das Projekt und dann die Pakete aus, für die Sie die JavaDoc Datei.

Anschließend stellt sich die Frage, was sind Javadocs und wann sollten sie verwendet werden? Javadoc ist ein Tool, das mit JDK geliefert wird und es ist Gebraucht zum Generieren von Java-Code-Dokumentation im HTML-Format aus Java-Quellcode, der eine Dokumentation in einem vordefinierten Format erfordert. */ sind mehrzeilige Java-Kommentare. Ebenso ist die Zeile vor // ein einzeiliger Java-Kommentar.

Was ist der Javadoc-Befehl in Anbetracht dessen?

Javadoc ist ein Befehl -line-Tool zum Extrahieren spezieller Kommentare (sogenannte doc-Kommentare) aus Java-Quelldateien und zum Generieren eines einfach zu verwendenden HTML-Dateibaums, der diese enthält. Die Kommentare können Standard-HTML-Markup enthalten und Javadoc @Stichworte. Die Java-API-Spezifikation ist ein Beispiel dafür, was Javadoc produziert.

Wie öffne ich eine Javadoc-Datei?

Um die zu lokalisieren Javadoc , navigieren Sie zu Ihrem Benutzerordner (unter Windows 7 ist dies C:Benutzer*Benutzername*) und navigieren Sie dann zu sunspotfrcsdk/doc/ Javadoc . Doppelklicken Sie auf den Index. html-Datei zu offen es in Ihrem Standard-Webbrowser.

Empfohlen: