Tag: javadoc

Javadoc ist eine erweiterbare Dokumentation generation-system, das liest speziell formatierte Kommentare im Java-Quellcode und generiert zusammengestellt Dokumentation. Es wird normalerweise verwendet, um zu produzieren API-Dokumentation in form von HTML-web-Seiten.

Warum nicht Eclipse finden Sie in der JavaDoc -?

Anzahl der Antworten 2 Antworten
Habe ich installiert die Java3D-API und der Dokumentation. Hier ist, wo ich bekam die Dokumentation von: http://www.oracle.com/technetwork/java/javase/tech/index-jsp-138252.html nun, ich folgte diesen Anweisungen, um installieren Sie die JavaDoc für Eclipse: JavaDoc in Eclipse-Android-Projekt Ich den Pfad der Dokumentation

Muss ich javadoc jede einzelne Methode oder nur um die 'main' - Methode in java?

Anzahl der Antworten 3 Antworten
So wie es momentan steht, diese Frage ist nicht eine gute Passform für unsere Q&A-format. Wir erwarten Antworten auf Tatsachen gestützt, Referenzen und know-how, aber diese Frage wird wahrscheinlich werben Debatte, Argumente, polling, oder erweiterte Diskussion. Wenn

Was bedeutet "optionale operation" bedeutet in der Javadoc von z.B.#add(E)?

Anzahl der Antworten 3 Antworten
Wenn in der java-Dokumentation für Set, heißt es in der Spezifikation einer Methode Optional Operation z.B. (Hervorhebung durch mich) add(E e) Fügt das angegebene element an dieses set, wenn es nicht bereits vorhanden ist (optionaler Betrieb). Was

Wie zu installieren javadoc für Android Compatibility Package?

Anzahl der Antworten 6 Antworten
Wie generieren Sie benutzerdefinierte javadoc für android 1.4 compatibility package? Die Referenz-Dokumente sind online verfügbar (Beispiel), aber gibt es einen Ort, wo kann ich eine zip mit javadoc offline verfügbar? Ich nehme an, mit der javadoc wäre

Latex Javadoc-generation

Anzahl der Antworten 3 Antworten
Gibt es einen Weg zur Erzeugung eines latex-Dokuments von meinem java-Quellcode-Dateien Dokumentation? Ich will nicht zu zählen LaTeX-Elemente in meiner Dokumentation Kommentare, ich möchte einfach zum erstellen von LaTeX-Dateien anstelle von HTML. Dank Möchten Sie zu schreiben

Sollten JUnit-tests werden javadocced?

Anzahl der Antworten 9 Antworten
Habe ich eine Reihe von JUnit-Testfällen, die derzeit nicht dokumentiert mit Javadoc-Kommentaren. Den rest von meinem code ist dokumentiert, aber ich Frage mich, ob es überhaupt der Mühe Wert, zu dokumentieren, diese tests. InformationsquelleAutor Jim | 2009-11-26

Javadoc für lokale Variablen?

Anzahl der Antworten 6 Antworten
Kurze Frage: Ist es möglich, erstellen von Javadoc-für lokale Variablen? (Ich möchte nur eine Erklärung für meine lokale variable, wenn die Maus über es in Eclipse) vielen Dank für jeden Hinweis 🙂 Sie können variable Beschreibung Methode

Publishing javadoc automatisch beim erstellen eines maven Projektes mit hudson

Anzahl der Antworten 4 Antworten
Ich bin mit Hudson bauen Maven-Projekte mit der entsprechenden Maven-2-job. leider kann ich Sie nicht finden jede Art und Weise zu veröffentlichen, die generierte javadoc-wie es getan werden kann, mit einem "Free Style" - job und die

Was bedeutet @link bedeuten in java/Android-Dokumentation?

Anzahl der Antworten 4 Antworten
Was bedeutet das: {@link KeyEvent#KEYCODE_ENTER} Ich habe gesehen es ein paar mal-und ich bin mir nicht ganz sicher, was es darstellt. Ich Schreibe ein Test-Programm mit Robotium, JUnit und Android. Wenn jemand anbieten könnte, eine Aufklärung über

JavaDoc: private Felder und Methoden

Anzahl der Antworten 1 Antworten
Was JavaDoc-tags sollte ich in die private Felder und Methoden zur Generierung der javaDoc-Beschreibungen? InformationsquelleAutor itun | 2011-04-13

Java EE 1.5 API-Dokumentation download

Anzahl der Antworten 4 Antworten
Wo kann ich laden Sie die API-doc für Java-EE-5? Alles was ich in die Hände bekomme, ist die online-API-doc unter : http://download.oracle.com/javaee/5/api/ Java-Dokumentation in der Windows-Hilfe-format allimant.org/javadoc/index.php InformationsquelleAutor Ayusman | 2011-04-14

Wie erstelle ich eine jar verteilbar für javadocs?

Anzahl der Antworten 2 Antworten
Habe ich eine API, die ich release, als eine JAR-Datei. Es ist proprietär, also musste ich ausziehen, das source-Dateien aus der it. Ich derzeit eine separate /doc Ordner enthält die Ausgabe des Eclipse-export-to-javadoc-Assistenten. Nicht schlecht, aber ich

Maven-checkstyle-Fehler : Erwartet @param-tag für " <T>'

Anzahl der Antworten 2 Antworten
Ich habe folgende Methode mit generischen Typen, aber wenn ich maven-checkstyle(maven-checkstyle-plugin, 2.121) es gehalten gibt mir Expected @param tag for '<T>' Fehlermeldung während des maven-build. Wie bekomme ich mehr mit diesem? /** * Read in specified type

Javadoc-Referenz-param aus einem anderen Verfahren

Anzahl der Antworten 3 Antworten
Möchte ich nicht schreiben, redundante javadoc-Kommentare. Wie Sie sehen können, @param x ist in einer Weise redundant. Gibt es einen javadoc-markup wählen Sie einen Verweis aus @param x in der Klasse B zu @param x in der

Wie soll man sich das verteilen der Javadoc für eine Bibliothek?

Anzahl der Antworten 3 Antworten
Schreibe ich eine benutzerdefinierte Bibliothek. Es ist build-in ein .jar-Archiv. Ich bin voll in der Lage, zum generieren der javadoc, aber ich weiß nicht, wie ich das verteilen? Legen Sie es in der gleichen .Glas mit der

Gibt es eine @inheritDoc entspricht in Doxygen?

Anzahl der Antworten 2 Antworten
Ich weiß Javadoc erstellen {@inheritDoc}, aber was ist der Doxygen Weg, dies zu tun? InformationsquelleAutor Roberto | 2011-04-04

Warnung: Baumeln Javadoc-Kommentar

Anzahl der Antworten 5 Antworten
Da ich aktualisierte mein Android Studio (2.3.1) und build-tools (2.3.1), ich erhalte eine Warnung, Achtung: Baumeln Javadoc-Kommentar für Kommentare wie, /** set name with format, {@Link FORMAT_NAME} **/ setNameText(getFormattedName(FORMAT_NAME)); Wie Sie sehen können, ich benutze javadoc-Stil-Kommentar für

"javadoc" in C#

Anzahl der Antworten 1 Antworten
Bin ich auf der Suche online, um herauszufinden, wie "javadoc" in C# - Konsolenanwendung. Alle Artikel finden Sie ein Formular, von C# in dem Fall, für, dass, /// wäre in der javadoc. Was ist der Weg, es

Einfügen von Bildern in javadocs

Anzahl der Antworten 7 Antworten
Arbeite ich mit einer Menge von Beispiel-Testfälle, die visual. Gibt es eine bequeme Möglichkeit, um Sie in meinem Java-Quellcode, und verknüpfen Sie Sie in den Javadocs, also meine IDE automatisch zeigen Sie Ihnen während der Codierung (durch

Javadoc UML-Diagramme Einfügen

Anzahl der Antworten 7 Antworten
Gibt es eine Möglichkeit zum einbetten von Bildern in mein JavaDoc? Im Grunde möchte ich einige UML-Diagramme Erläuterung der Hierarchie meiner Klassen in irgendeiner Dokumentation. Dank! +1 ich wünschte, ich würde haben baten diese mich! InformationsquelleAutor Mo

Wie kann ich schnell erstellen Javadoc-links zu Elementen in Eclipse?

Anzahl der Antworten 2 Antworten
Möchte ich einfach Verknüpfungen erstellen, um Klassen, Methoden, Felder, etc. aus meiner Javadocs, ohne dass Sie aus dem vollen Ausdruck z.B. {@link AllowAllHostnameVerifier}. Was ist der Schnellste Weg, dies zu tun in Eclipse? InformationsquelleAutor Jeff Axelrod |

Eclipse : Liste der Methoden und Variablen für alle Klassen

Anzahl der Antworten 6 Antworten
Ich bin seit einigen Java-code, der geschrieben wurde von jemand anderem. Muss ich das verstehen, ändern und testen Sie es. Der Autor ist momentan nicht verfügbar. Das Paket hat etwa 50 Dateien (und damit Klassen) in verschiedenen

Wie Sie auf Beschreibung hinzufügen, um die Methode oder Klasse

Anzahl der Antworten 6 Antworten
Wie kann ich die add-Methode Beschreibung in Java ? Ich benutze NetBeans IDE. InformationsquelleAutor Talha | 2013-03-20

Generierung von javadoc als word-Dokument

Anzahl der Antworten 5 Antworten
Wie können wir das generieren der javadoc als word-Dokument anstelle der traditionellen html-Seiten? InformationsquelleAutor ria | 2009-10-22

Importieren von Javadoc-Dokumentation auf Basis von Eclipse

Anzahl der Antworten 1 Antworten
Ich bin neu in Eclipse, ich bin mit OWL-API von Protégé und ich würde gerne importieren, um diese IDE seine Javadoc-Dokumentation, die online zugänglich ist im html-format. Wie mache ich es? InformationsquelleAutor Anto | 2010-03-18

Wie fügen Sie Javadoc für die Servlet-API in Eclipse

Anzahl der Antworten 5 Antworten
Habe ich eine dynamische web-app in Eclipse mit Tomcat als Laufzeitumgebung. Kann ich nicht fügen Sie Javadoc-Pfad der Tomcat Servlet-API: wie erscheint der edit-button ist immer deaktiviert! alt-text http://filaty.com/i/1005/80306/tom.JPG InformationsquelleAutor Muhammad Hewedy | 2010-05-19

Eine gute Referenz für beliebte javadoc-tags zu verwenden?

Anzahl der Antworten 4 Antworten
Ich möchte die benutzerdefinierten tags in meiner javadocs, aber halten Sie irgendeine Art von Konvention, damit andere Menschen haben vielleicht eine einfachere Zeit, darin einen Sinn zu finden. Auf die Oracle-offiziellen javadoc-Dokumentation Seite, die Sie aufgeführt habe,

Maven-Abhängigkeit mit javadocs

Anzahl der Antworten 3 Antworten
3 Fragen: Unten sind zwei maven Abhängigkeiten für JUnit. Ich habe wurden scheuern der interwebs für Stunden und kann nicht scheinen, um zu bestimmen, ob die zweite ist Javadoc + code oder nur Javadoc. Brauche ich eine

Habe ich Probleme, schreiben von Javadoc-Kommentare für die main-Methode @param

Anzahl der Antworten 1 Antworten
Ich bin sehr neu in Java und die Einnahme einen online-Kurs mit wenig feedback. Ich denke, dass ich das Programm abgeschlossen okay, aber mein prof verlangt Kommentaren zu tun und ich habe keine Hinweise auf Sie. Meine

Wie man spring javadoc in eine jar - /zip-Datei

Anzahl der Antworten 6 Antworten
Eigentlich will ich integrieren Frühjahr javadoc mit meinem netbeans-IDE. Frühling website stellt nur eine javadoc-HTML-version online, kein download-link. Aber Netbeans akzeptieren nur eine jar - /zip-Datei oder einen lokalen Ordner. Ich weiß, ich kann es mir ab

Wie kann eine Methode Javadoc kopiert werden in andere Methode ist Javadoc?

Anzahl der Antworten 2 Antworten
Ich weiß, dass es @inheritDoc, aber es ist nur für Methoden, die andere überschreiben. Ich habe mehrere Klassen mit vielen delegieren Methoden (die nicht andere überschreiben). Können Ihre Javadoc-sein "geerbt" (genauer: kopiert)? /** here I need the

Visual Studio habe eine option zur Erstellung von html-Dokumentation mit Javadoc-Stil Kommentare?

Anzahl der Antworten 2 Antworten
Visual Studio eine option zum generieren von html-Dokumentation mit Javadoc-Stil Kommentare? Wenn ja, welche Schritte sind notwendig, um dies zu erreichen? In BlueJ gibt es eine option zum übersetzen Javadoc-Stil Kommentare in eine html-Datei. Wie das folgende

Wo ist mein JavaDoc in Jenkins

Anzahl der Antworten 1 Antworten
Wo muss ich konfigurieren, wo Jenkins finden JavaDoc-Dateien. Ich konnte sehen, dass die JavaDoc-Plugin installiert ist aber ich fand keine Stelle, wo ich wäre in der Lage es zu konfigurieren. Dies ist mein pom.xml <build> <plugins> ...

gewusst wie: hinzufügen von javaDoc zu meinen Java-code in einer NetBeans-basierten Projekt?

Anzahl der Antworten 9 Antworten
Wie kann ich add JavaDoc oder andere Dokument zu netbeans ? Ich versuche mit auf diese Weise : Tools >> Java Platform >> JavaDoc Tab >> JavaDoc.zip (in my desktop) aber im editor wenn ich drücken Sie

Deaktivieren Sie alle JavaDoc in Gradle

Anzahl der Antworten 3 Antworten
Update allgemein, nach einigen Recherchen Will ich bauen, mein Projekt läuft gradle 2.0 mit gradle build in die Konsole stecken ich in die JavaDoc-generation. Ich bin mit Java 8, precisly jdk1.8.0_66 und jre1.8.0_66. Wenn ich jetzt bauen

Hinzufügen von java-docs, um ein Programm in netbeans

Anzahl der Antworten 3 Antworten
Wie kann ich java-docs auf mein java-Programm mit netbeans? Javadocs sind Kommentare, die beginnen mit /** und kommen vor Klassen und Methoden. Geben Sie einfach Ihnen. Was willst du mehr? Was Fragen Sie? mehrere Versionen von NB

JavaDoc-plugin für eclipse?

Anzahl der Antworten 3 Antworten
Ich war auf der Suche nach einem javadoc-plugin für eclipse, so dass ich das Dokument kann für Methoden etc. Ich weiß, in eclipse, die Sie tun können ALT + SHIFT + J aber ich Frage mich, ob

Wie generieren von javadoc mit Gradle?

Anzahl der Antworten 1 Antworten
Ich möchte generate javadoc aus aar-lib-Datei, aber meine eigentliche Aufgabe nicht und beenden mit Fehler. Ich bin etwas verloren mit gradle. Wo sollte generieren von javadocs? android.libraryVariants.all { variant -> //This part is for change AAR location

Javadoc-Verknüpfung zu einer Klasse in ein anderes Paket

Anzahl der Antworten 2 Antworten
Ich habe zwei Pakete, Shapes und Fruits: com.myproject.Shapes. Circle Square Triangle com.myproject.Fruits. Apple Orange Schreibe ich die JavaDoc für Apple und brauchen ein {@link} zu Square. Habe ich versucht, alle der folgenden, und keiner von Ihnen arbeiten:

javadoc-auto generation für intellij

Anzahl der Antworten 1 Antworten
Gibt es eine automatische Javadoc-generation-plugin für IntelliJ? Beispiel http://jautodoc.sourceforge.net/ InformationsquelleAutor joshjdevl | 2011-01-13

Generieren von Javadoc-Fehler Android Studio

Anzahl der Antworten 5 Antworten
Aus irgendeinem Grund ich kann nicht generiert werden (javadoc mit Android Studio, nach wie 96 Warnungen es gibt mir diese: 95 warnings java.lang.NullPointerException at com.sun.tools.javadoc.TypeMaker.getType(TypeMaker.java:83) at com.sun.tools.javadoc.TypeMaker.getType(TypeMaker.java:44) at com.sun.tools.javadoc.ClassDocImpl.superclassType(ClassDocImpl.java:496) at com.sun.tools.doclets.internal.toolkit.util.Util.getAllInterfaces(Util.java:453) at com.sun.tools.doclets.internal.toolkit.util.Util.getAllInterfaces(Util.java:491) at com.sun.tools.doclets.internal.toolkit.util.ClassTree.processType(ClassTree.java:194) at com.sun.tools.doclets.internal.toolkit.util.ClassTree.buildTree(ClassTree.java:146)

Wie zu generieren der Javadoc-HTML-Dateien in Eclipse?

Anzahl der Antworten 4 Antworten
Ich geschrieben habe Javadoc-Stil Kommentare wie diese in meinem Projekt-code: /** * Description... * * @param ... * @return ..... */ Wie kann ich das generieren der Javadoc-HTML-Dateien mit Hilfe der Eclipse-IDE? InformationsquelleAutor JaneNY | 2010-12-17

Wie eine Methode zu dokumentieren, die eine andere Methode überschreibt?

Anzahl der Antworten 2 Antworten
Ich mich immer gefragt, wie eine Methode zu dokumentieren, der überschreibt eine Nachricht, die von einer Basisklasse. Normalerweise füge ich ein java-doc an jede öffentliche Methode und einige private, protected-Methoden. Aber autogenerating eine Dokumentation block für eine

Was ist die richtige Art zu schreiben javadoc in der abstrakten Methoden

Anzahl der Antworten 1 Antworten
public interface ISomething /** * This method does something! */ public void something(); } public abstract class AbstractSomething implements ISomething { /** * See {@link #doSomething()} */ public final void something() { doSomething(); //Do something else... ...

Tags in javadoc-Kommentare für die interface-Methoden?

Anzahl der Antworten 1 Antworten
Schreibe ich ein interface in java, und ich Frage mich, ob ich sollte include-tags in die Schnittstelle der Methode javadoc-Kommentaren (@param, @return, etc.) oder wenn ich nur die tags in der Implementierung von Klassen-Methode " werden die

Netbeans-Javadoc nicht gefunden, auch wenn die Bibliothek hat es definiert

Anzahl der Antworten 2 Antworten
Ich habe ein problem mit Netbeans einfach nicht erkennen Javadocs in externen Bibliotheken. Ich habe mich in den library-Pfad und dem angegebenen gültigen javadoc-Pfad (Netbeans akzeptiert den Pfad ohne Fehler). Aber auch nach dem re-Bau/öffnung schließen mit

Java apache poi: excel-Zelle Farbe

Anzahl der Antworten 3 Antworten
Ich versuche, ändern Sie den hintergrund einer Zelle mit apache poi. Ich weiß es gibt eine Menge Antworten, aber ich verwende die neueste version, (3.16) und Sie sind alle veraltet. Zum Beispiel all die Antworten zeigen, dass

Javadoc nicht in Eclipse

Anzahl der Antworten 4 Antworten
Ich bin mit Eclipse IDE für Java-Entwickler Version: Helios Service Release 2 Build-id: 20110218-0911 Ich habe ein problem ähnlich diesem stackoverflow-Frage Auf dem Lesen der anderen Fragen, ich habe den Fehler gefunden das Dieses element hat keine

Javadoc für die Wiederverwendung und das überladen von Methoden

Anzahl der Antworten 4 Antworten
Entwickle ich eine API mit vielen gleichnamigen Methoden unterscheiden sich gerade durch die Signatur, die ich denke, ist ziemlich weit verbreitet. Sie alle tun das gleiche, außer dass Sie initialisieren Sie die verschiedenen Werte durch die Standardwerte,

Private member-Variablen in Java-docs

Anzahl der Antworten 2 Antworten
Warum sollten private member-variable verwendet, die durch Getter/setter haben in Ihrer Beschreibung angegeben, in den javadocs der Beschreibung der entsprechenden Getter und setter. Wer hat gesagt, dass Sie sollten? Solange die getter/setter dokumentiert ist, sehe ich keinen