javadoc

Fragen
Javadoc ist ein erweiterbares Dokumentationsgenerierungssystem, das speziell formatierte Kommentare im Java-Quellcode liest und kompilierte Dokumentation generiert. Es wird normalerweise verwendet, um API-Dokumentation in Form von HTML-Webseiten zu erstellen.
2
Antworten

Besteht ein Nachteil darin, API-Code zusammen mit den Klassen in ein JAR zu schreiben?

Wenn Sie in Java die Quellcodedateien ( .java) zusammen mit Klassen ( .class) packen, werden die meisten IDEs wie eclipse die javadoc-Kommentare für die Codevervollständigung anzeigen. IIRC gibt es einige Open-Source-Projekte, die das wie JMo...
22.05.2010, 13:45
3
Antworten

Erstelle ein einzelnes jar, das kompilierte Klassen enthält, und javadoc mit Maven

Ich versuche, eine JAR-Datei zu generieren, die ein API-SDK für unser Produkt enthält, damit unsere Kunden Plugins erstellen und sie mit unserer API kompilieren können. Alle Klassen / Schnittstellen, die wir als Teil unseres API-SDK-Krugs bereit...
20.02.2013, 19:11
3
Antworten

Bearbeiten von Javadoc $ {tags} Variable von Eclipse

Version: Luna Service Release 2 (4.4.2) Ich verwende in der Regel die Methode "/ **", um Javadoc in meine Methoden einzufügen. Eclipse fügt @param für alle Args, @throws für alle Throwables und% @return ein. Der @return hat jedoch...
15.12.2015, 13:17
1
Antwort

Wie sag javadoc, dass meine Periode einen Satz nicht beendet

javadoc verwendet den ersten "Satz" eines Dok-Kommentars als Zusammenfassung. Es wird davon ausgegangen, dass ein Punkt, gefolgt von einem Leerzeichen, Tabulator oder Zeilenabschluss, den Satz beendet. Angenommen, ich möchte eine Abkürzung wie "...
16.08.2013, 21:01
3
Antworten

javadoc-ähnliches Werkzeug für Spring-Mvc Rest api Dokumentation? [geschlossen]

Ich war auf der Suche nach einem javadoc-ähnlichen REST-API-Dokumentationstool . Ich habe bereits meine Ruhe-Controller in Javadoc dokumentiert und ich denke, es wäre schön, einfach eine API-Dokumentation daraus für die Front-End-Entwickler zu...
22.11.2010, 10:37
3
Antworten

Maven Javadoc-Plugin, wie generierte Quelle auszuschließen

Einige Moven-Plugins können zusätzlichen Quellcode erzeugen, zB. jaxb2. Ich möchte die Erstellung von Javadocs aus dem Verzeichnis target/generated-sources überspringen. Wie konfiguriert man maven-javadoc-plugin um dies zu erreichen?...
03.06.2016, 22:43
1
Antwort

{@inheritDoc} erbt nicht Superklasse javadoc in Eclipse

Wenn ich {@inheritDoc} in Eclipse verwende, erscheinen die javadoc-Kommentare der Oberklasse nicht im Javadoc meiner Klasse. Ich habe das folgende Stück Code: %Vor% Ich stelle sicher, dass rt.jar library (welches javax.swing.table.Abstrac...
07.08.2009, 05:41
3
Antworten

Erstellen Sie Javadoc mit mehreren Quellverzeichnissen

Ich habe ein Util-Paket mit Quelldateien in drei separaten Verzeichnissen, die wie folgt definiert sind: src / com / domain / util src / Standard / com / domain / util src / Erweitert / com / domain / util Das Paket wird mit dem erste...
22.02.2010, 21:48
1
Antwort

Wie kann Javadoc von Scala-Code beim Verteilen von Bibliotheks-Jars eingebunden werden?

Diese Frage bezieht sich auf das Aufrufen von Scala-Code aus Java-Code. Wenn ich eine Scala-Bibliothek (im Jar-Format) einfüge, haben die Rückgabetypen oft den Typ scala.collection und andere Scala-Typen. Wenn ich in Java (in Netbeans)...
07.06.2011, 07:54
0
Antworten

Wie konfiguriere ich Eclipse, um sich über die gleichen Fehler zu beschweren, über die das Java 8 javadoc-Tool klagt?

Seit Java 8 ist das javadoc-Tool, das mit dem JDK geliefert wird, um einiges wählerischer bei fehlerhaftem HTML, fehlenden Parametern und so. Eclipse JDT enthält einen Javadoc-Parser, der über Einstellungen konfiguriert werden kann - & gt; Java...
30.07.2015, 10:08