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.
Wie füge ich einen Bezug zu einem Methodenparameter in Javadoc hinzu?
4 Antworten
Ist es ein Weg, um fügen Sie Verweise auf einen oder mehrere Parameter einer Methode aus der Dokumentation der Methode Körper? So etwas wie: /** * When {@paramref a} is null, we rely on b for the
Verfügbarmachen von JavaDocs mit GitHub, Sonatype Maven Repo
4 Antworten
Obwohl Github bietet ein schönes Zuhause für die Java-open-source-Projekten, es gibt einige Dinge, die noch fehlen, im Vergleich zu mehr ausgereifte open-source-hosting-Orte. Ich habe bisher herausgefunden, dass Sonatype bietet Maven-repository Zugang für open-source-Projekte, die löst ein Problem;
Wie erstellt man JavaDoc mit Android Studio ohne R und BuildConfig?
3 Antworten
Möchte ich zum generieren der JavaDoc für meine Bibliothek ohne R und BuildConfig. Die Generate JavaDoc... Funktionalität von der Tools Menü nicht die option zum ausschließen von Dateien. Wie zum erstellen von JavaDoc mit Android Studio ohne
Kann Maven-Projekt wegen Javadoc-Fehler nicht bauen?
3 Antworten
hat jemand ein ähnlich maven Fehler unten? ich bin nicht in der Lage zu bauen, mein Projekt aufgrund der folgenden Fehler. Alle zuvor tätig war gut, bevor ich begann mit der Arbeit am code. Habe ich nicht
Eclipse Javadoc-Assistent generieren: Was ist "Javadoc-Befehl"?
4 Antworten
Möchte ich generieren die javadocs für ein open-source-code-Basis verwende ich. Aber ich wurde aufgefordert, mich für eine "Javadoc Command", die von der Eclipse Generieren von JavaDoc-Assistenten und die Hilfe nicht erklären, was das bedeutet. Ist es zu
Was ist der richtige Weg, um eine E-Mail in Javadoc aufzunehmen?
1 Antworten
Ich gerne mein E-Mail-Adresse innerhalb von @author tags und möchten, dass Sie anklickbar mailto: links im generierten Javadoc. Wie gehe ich dabei richtig? /** * I currently do the following, but would like to have my name
Javadoc-Vorlagengenerator
6 Antworten
Ich habe eine große Codebasis ohne Javadoc, und ich möchte ausführen, ein Programm zu schreiben, das Skelett mit der basic-Javadoc-Informationen (z.B. für jede Methode parameter schreiben @param...), so dass ich nur zum füllen der Lücken. Weiss jemand
Wie fügt man javadoc oder Quellen zu jars im libs Ordner hinzu?
12 Antworten
Neue version des ADT-r17-plugin für die Eclipse-Funktion Hinzugefügt, um automatisch die setup-JAR-Abhängigkeiten. Alle .jar-Dateien in das /libs-Ordner Hinzugefügt werden, die build-Konfiguration jetzt. Leider Android-Abhängigkeiten classpath-container nicht änderbar. Wie kann ich anfügen, javadoc und sources, die automatisch eingefügt
Javadoc in Junit Testklassen?
3 Antworten
Ist es eine best practice zu setzen Javadoc-Kommentare in junit-test-Klassen und-Methoden? Oder ist die Vorstellung, dass Sie so einfach zu Lesen und einfach, dass es unnötig ist, um eine Erzählung der test-Absicht? InformationsquelleAutor der Frage HDave |
Wie kompiliert man Javadoc auf einfachste Weise aus Quellen?
6 Antworten
Angenommen ich habe Projektverzeichnis MyProjectunter denen ich src Verzeichnis mit den Quellen des Programms. Ich kompilieren wollen alle javadocs von dort. Was ist der einfachste Befehl zur Ausgabe von? Wenn ich javadoc -sourcepath ./src -d ./docs Bekomme
C / C ++ Header-Datei-Dokumentation
5 Antworten
Was denken Sie, ist die beste Praxis bei der Erstellung der öffentlichen header-Dateien in C++? Sollten header-Dateien enthalten keine, kurze oder massive Dokumentation? Ich habe alles gesehen aus fast keine Dokumentation (unter Berufung auf einige externe Dokumentation)
Wie kann ich das Javadoc automatisch aktualisieren, wenn ich die Methodensignatur in Eclipse ändere?
6 Antworten
Ich bin mit Eclipse IDE für mein Java-Projekt. Habe ich ein problem. Ich habe die Methoden in meinem Projekt, die den javadoc-Kommentaren wie folgt: /** * Retruns the string representation of a input stream * @param in
Wie man die Quellen der externen Bibliothek und Javadoc hinzufügt, um mit IntelliJ zu gruppieren?
5 Antworten
Ich habe ein Java-Projekt mit IntelliJ und Gradle. Ich habe einen zu bauen.gradle-Datei in mein root-Projekt und ich kann es kompilieren und ausführen meiner app. Aber... ich bin mit einem Java-Bibliothek, die mit einem Quellen-und javadoc-zip-Datei. Wenn
Javadoc-Link zu Methode in einer anderen Klasse
3 Antworten
Derzeit bin ich verweisen auf Methoden in anderen Klassen mit dieser Javadoc-syntax: @see {@link com.my.package.Class#method()} Und in dem, was ich verstehe aus der Dokumentation dies ist der richtige Weg, dies zu tun. Aber jetzt zum lustigen Teil,
Warum verwendet der standardmäßige IntelliJ-Standardklassen-Javadoc-Kommentar eine nicht standardmäßige Syntax?
5 Antworten
Warum hat die Standard-IntelliJ Standard-Klasse javadoc-Kommentar die Verwendung von nicht-standard-syntax? Anstatt eine Zeile mit "User: jstauffer" es könnte eine Zeile mit "@Autor jstauffer". Die anderen Linien, die es erstellt (Datum und Zeit) wahrscheinlich nicht javadoc-syntax zu benutzen,
Wie kann ich Javadoc für die Android-Support-Bibliothek aktivieren?
3 Antworten
Bei Verwendung der Android support Bibliothek für Kompatibilität und versuchen, die javadoc für, sagen wir, FragmentTransactionbekomme ich die folgende Fehlermeldung, weil es keine zugehörigen javadoc-Datei: android.Unterstützung.v4.app.FragmentTransaction Hinweis: Dieses element hat weder angebracht-Quelle noch attached Javadoc und damit
Autorennamen in Eclipse automatisch zu vorhandenen Dateien hinzufügen
5 Antworten
Ist es ein wirklich einfach zu bedienendes tool (keine monster-tool) , kann ich das plug-in Eclipse, und drücken Sie "Kopfzeile erstellen" klicken und dann auf der Autoren-name erscheint in der jede Datei in diesem Projekt? InformationsquelleAutor der
Wie dokumentiere ich Pakete in Java?
3 Antworten
In der Java-APIs, die ich sehen kann, Javadoc-Kommentare für Pakete. Wie/wo platziere ich den Javadoc-Kommentaren zu dokumentieren, ein Paket? InformationsquelleAutor der Frage jjnguy | 2009-03-08
Wie generiere ich Links zu den Referenzen der android Klassen in javadoc?
6 Antworten
Wenn ich generieren von javadoc für mein Android-Projekt in Eclipse, es gibt viele Warnungen wie cannot find symbol symbol : class TextView und warning - Tag @see: reference not found: android.app.Dialog Ich habe auch versucht -link http://developer.android.com/reference/
Überschriebene Methoden in JavaDoc
2 Antworten
Bin ich dokumentieren ein Java-Programm, das ich entwickelt habe, und wollte wissen, ob JavaDoc generiert wird, für eine geerbte Methode (wird überschrieben), wenn ich nur Dokument der Oberklasse? Wenn ich eine Klasse namens Vehicle mit einem drive()
Sollten Javadoc-Kommentare zur Implementierung hinzugefügt werden?
7 Antworten
Ist es richtig, die Praxis zu fügen Sie Javadoc-Kommentare in die Schnittstelle und der non-Javadoc-Kommentare in der Umsetzung? Meisten IDEs generieren non-JavaDoc-Kommentare für Implementierungen, wenn Sie die automatische Generierung von Kommentaren. Sollte nicht die konkrete Methode haben
Maven funktioniert nicht in Java 8, wenn Javadoc-Tags unvollständig sind
16 Antworten
Da ich Maven war ich in der Lage zu bauen und zu installieren, in meinem lokalen repository der Projekte, die unvollständig Javadoc-tags (beispielsweise ein parameter fehlt). Da ich jedoch die Migration zu Java 8 (1.8.0-ea-b90) Maven ist
Maven Javadoc Plugin - wie kann ich nur bestimmte Klassen einbeziehen?
5 Antworten
Mithilfe des Maven-javadoc-plugin können Sie ausschließen, bestimmte Pakete - aber ich habe viele Pakete und nur eine Handvoll Klassen, die ich produzieren möchten Javadoc. Gibt es eine Möglichkeit zu zählen, anstatt Sie auszuschließen? Ich würde auch gerne
Erstelle ein Javadoc für mein Android-Projekt
11 Antworten
ich hatte gehofft, jemand könnte mir helfen, im generieren von javadoc für mein eclipse-Projekt. Wenn ich die Option 'Generate Javadoc" aus dem Projekt-Menü, bekomme ich viele Fehler wie cannot find symbol symbol : class ListView jedesmal, wenn
Wie schreibe ich Javadoc-Links?
3 Antworten
Wie Schreibe ich einen Link in den javadocs? Derzeit, ich habe so etwas wie: {@link java.lang.Math#sqrt(double) Math.sqrt} produzieren den text Math.sqrt sollte link zu der java.lang.Math.sqrt(double) API, aber alle es tut, ist, erzeugen die text, kein link.
Abrufen von Quell-JAR-Dateien an Eclipse für von Maven verwaltete Abhängigkeiten
17 Antworten
Ich bin mit Maven (und das Maven-Eclipse-Integration) zum verwalten der Abhängigkeiten für meine Java-Projekte in Eclipse. Die automatische download-Funktion für JAR-Dateien aus dem Maven-Repositorys ist eine echte Zeitersparnis. Leider ist es nicht API-Dokumentation und source-code. Wie kann
JSON.Simple API Javadoc
1 Antworten
Gibt es einen Javadoc für JSON.einfach? InformationsquelleAutor der Frage cp. | 2010-04-14
Wie füge ich die Java-API-Dokumentation zu Eclipse hinzu?
13 Antworten
Habe ich heruntergeladen, Java-API-Dokumentation von http://www.oracle.com/technetwork/java/javase/downloads/index.html#docs und haben angeblich befestigte es an Eclipse mit dem Fenster->Einstellungen->Java->Installiert JREs->Bearbeiten->"Wählen Sie rt.jar"->Javadoc Lage Und die Lage akzeptiert worden ist und "Überprüft" einfach nur gut. Aber für das Leben von mir,
Simple Getter / Setter Kommentare
15 Antworten
Welche Konvention Sie verwenden, um Kommentar Getter und setter? Dies ist etwas, das Frage ich mich seit geraumer Zeit, zum Beispiel: /** * (1a) what do you put here? * @param salary (1b) what do you put
Welches Tag sollte in Javadoc als Absatztrennzeichen verwendet werden?
3 Antworten
Welches die entsprechenden HTML-tag für das Aufbrechen Absätze/lange Abschnitte von javadoc-so nach best practices? Ist es <p /> oder <br />? Warum? InformationsquelleAutor der Frage Tom Tresansky | 2011-03-10
Wie generiere ich javadoc-Dokumentation mit Umlauten?
3 Antworten
Ich versuche zu generieren, die Java-Dokumentation in Eclipse. Die source Dateien sind UTF-8-kodiert und enthalten einige Umlaute. Die resultierenden HTML-Dateien, die nicht angeben, die eine Kodierung und verwenden Sie keine HTML-Entitäten, so dass die Umlaute nicht richtig
Gradle, Javadoc und Android Dokumentation
2 Antworten
Ich bin jetzt mit Gradle für alle meine Projekte und auch für die javadoc-generation. android.libraryVariants.all { variant -> task("generate${variant.name}Javadoc", type: Javadoc) { title = "$name $version API" source = variant.javaCompile.source ext.androidJar = "${android.plugin.sdkDirectory}/platforms/${android.compileSdkVersion}/android.jar" ext.googlePlayServicesJar = "${android.plugin.sdkDirectory}/extras/google/google_play_services/libproject/google-play-services_lib/libs/google-play-services.jar" classpath
Wie man Javadoc von der Befehlszeile erzeugt
7 Antworten
Kann jemand mir zeigen, wie das generieren von Javadoc von der Kommandozeile aus? Mein Projekt enthält das Paket com.test und ich möchte die generierte Dokumentation in Dateien in einem bestimmten Ordner wie diesem: C:/javadoc/test. InformationsquelleAutor der Frage
Wie bekomme ich ein JavaDoc einer Methode zur Laufzeit?
5 Antworten
Seine leicht zu bekommen a method Name einer Class zur Laufzeit ABER Wie kann ich eine JavaDoc einer Methode zur Laufzeit ? Wie das folgende Beispiel Unserer Klasse, die gehören JavaDoc unsere Ziel-Methode public class MyClass {
javadoc @link
2 Antworten
Schrieb ich zwei Methoden in der Klasse Util: public static final <T> T copy1(T source) {...} public static final <T> T copy2(T source) {...} Javadoc für Methoden copy2 umfasst: {@link #copy1(Object) copy} und als test beinhaltet auch:
Javadoc {@inheritDoc} -Klasse
3 Antworten
Ich würde gerne die {@inheritDoc} Klasse Erben, Methoden aus meiner abstrakten Klasse. In der Dokumentation für die abstrakte Klasse, ich beziehe mich auf das abstrakte Klasse mit Namen. Wie kann ich tag das so, wenn die Unterklasse
Erlaubte HTML-Tags in Javadoc
2 Antworten
Die Checkstyle-Regel JavadocStyle nicht erlauben, dass der tag <u>. Laut der docs, die überprüft wurden gemustert, nachdem die Prüfungen durch die DocCheck doclet bei Sun erhältlich. Leider habe ich nicht gefunden DocCheck überall. Weder habe ich irgendeine
Verwendung von @see in JavaDoc?
4 Antworten
Wann nutze ich @see beim Umgang mit JavaDocs? Was ist Ihre Verwendung? Zum Beispiel, wenn MethodA Anrufe MethodB dann muss ich setzen @see im MethodB's javadoc und Referenz MethodA weil das ist, was es nannte, oder tun
Javadoc @ return Tag Kommentar Duplikation notwendig?
2 Antworten
Für Funktionen, die sich nicht ändern, den Status einer Instanz, in der javadoc-Kommentar für die Methode ist oft gleich oder sehr ähnlich, wie der der @return-tag in der Java-API. boolean Sammlung.isEmpty() Gibt true zurück, wenn diese Sammlung
Verwenden Sie Javadoc für jede Methode, die Sie schreiben?
19 Antworten
Soll ich schreiben Doc-Kommentare für alle meine java-Methoden? InformationsquelleAutor der Frage mawaldne | 2008-10-17
Wie automatisch Kommentare für Getter / Setter basierend auf Feld Kommentare in Eclipse generieren?
9 Antworten
Ich möchte von Eclipse automatisch generieren von Javadoc-Kommentaren für meine getter-und setter-Methoden auf der Basis der zuvor definierten Kommentare für die Felder. Wie kann ich das erreichen? Hintergrund: Eine Politik, in unserer Gesellschaft ist der Kommentar, jede
Autovervollständigung von @author in Intellij
2 Antworten
Ich bin der Migration von Eclipse zu Intellij Idea. Eine Sache, die ich konnte nicht herausfinden, doch ist die Autovervollständigung von der @author JavaDoc-tag. Bei der Eingabe @a in Eclipse gibt es zwei Vorschläge: @author - author
JavaDoc: Wo fügen Sie Anmerkungen / Bemerkungen zur Dokumentation hinzu?
4 Antworten
Beim Programmieren in C# ich habe immer gefunden, das tag remarks sehr hilfreich, um Hinweise über die Implementierung einer Klasse oder Methode, oder zu geben, Informationen über die Theorie, was ich umsetzen. Ich bin jetzt mit Java
Eclipse wie man ein jar mit javadocs / source mit seinem binary verbindet?
5 Antworten
Ich würde gerne die javadoc-Kommentare, die in einer jar-Datei zeigen, in eclipse, wenn ich den Mauszeiger über eine Klasse. Beispielsweise nach dem herunterladen JODA-2.0, drei Gläser entnommen werden: joda-time-2.0 joda-time-2.0-javadoc joda-time-2.0-Quellen (http://sourceforge.net/projects/joda-time/files/joda-time/2.0/joda-time-2.0-dist.zip/download) In eclipse, [rechts klicken Sie
Wie ändere ich die in Eclipse generierte Javadocs-Vorlage?
5 Antworten
Ich mag nicht die Standard-Javadocs generiert für mich, wenn ich eine Klasse oder Methoden, vor allem die @author-variable, welche die aktuelle system-Benutzernamen auf meinem windows-Rechner. Möchte ich es ändern. Ist das möglich? InformationsquelleAutor der Frage Olaseni |
Javadoc @see Objektmethode
3 Antworten
Ich würde gerne die link-Methode ein anderes Objekt mit der @sehen aus einem Kommentar-block @sehen, ist nur geben Sie mir die option zum link-Klassen, nicht die Methoden. Was ist der hacken? public class A { B bee;
javadoc: @version und @since
4 Antworten
Gibt es einen Grund warum beide @version und @since als Teil einer Klasse? Scheinen Sie sich gegenseitig auszuschließen. Auch nicht, was %I% und %G% bedeuten, und wie einstellen/verwenden Sie? @version %I%, %G% Dank InformationsquelleAutor der Frage |
JavaDoc für private / geschützte Methoden?
5 Antworten
Soll ich schreiben JavaDoc für private oder geschützt Methoden? Und was ist mit private Variablen? Sehe ich Beispiele aus dem Unterricht auf meinem Java-Buch und die private Variablen sind in der JavaDoc ' ed. Also ich kann
Warum erhalte ich beim Generieren von Javadocs eine ClassCastException?
4 Antworten
Ich bin mit ant zum generieren von javadocs, bekomme aber diese Ausnahme immer und immer wieder - warum? Ich bin mit der JDK-version 1.6.0_06. [javadoc] java.lang.ClassCastException: com.sun.tools.javadoc.ClassDocImpl cannot be cast to com.sun.javadoc.AnnotationTypeDoc [javadoc] at com.sun.tools.javadoc.AnnotationDescImpl.annotationType(AnnotationDescImpl.java:46) [javadoc] at
Wie verwende ich das @value-Tag in Javadoc?
2 Antworten
Bin ich mit einer Klasse mit privatem Konstruktor statt einem enum (dies ist eine Anforderung). Und jetzt versuche ich, fügen Sie javadoc-tags zu Dokument jedes public static final Einheit. 1) Was ist der bevorzugte Ort, um javadoc-tags: