Als «javadoc» getaggte 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.

3
Wie verweise ich auf eine Methode in Javadoc?
Wie kann ich das @linkTag verwenden, um eine Verknüpfung zu einer Methode herzustellen? Ich will es verändern: /** * Returns the Baz object owned by the Bar object owned by Foo owned by this. * A convenience method, equivalent to getFoo().getBar().getBaz() * @return baz */ public Baz fooBarBaz() zu: /** …
864 java  hyperlink  javadoc 


15
Beispiel für mehrzeiligen Code im Javadoc-Kommentar
Ich habe ein kleines Codebeispiel, das ich in den Javadoc-Kommentar für eine Methode aufnehmen möchte. /** * -- ex: looping through List of Map objects -- * <code> * for (int i = 0; i < list.size(); i++) { * Map map = (Map)list.get(i); * System.out.println(map.get("wordID")); * System.out.println(map.get("word")); * } …
531 java  html  javadoc 


17
Maven funktioniert in Java 8 nicht, wenn Javadoc-Tags unvollständig sind
Seit ich Maven verwende, kann ich in meinen lokalen Repository-Projekten unvollständige Javadoc-Tags (z. B. einen fehlenden Parameter) erstellen und installieren. Seit ich auf Java 8 (1.8.0-ea-b90) migriert bin, ist Maven absolut streng in Bezug auf fehlende Dokumentations-Tags und zeigt mir viele Javadoc-Fehler im Zusammenhang mit Javadoc-Problemen, wenn ich versuche, ein …

12
Wie hänge ich Javadoc oder Quellen an Jars im libs-Ordner an?
Neue Version des ADT r17-Plugins für Eclipse hinzugefügt, um JAR-Abhängigkeiten automatisch einzurichten. Alle JAR-Dateien im Ordner / libs werden jetzt zur Build-Konfiguration hinzugefügt. Leider kann der Klassenpfadcontainer für Android-Abhängigkeiten nicht geändert werden. Wie kann ich Javadoc und Quellen an die automatisch eingefügte JAR-Datei (aus dem Ordner / libs) anhängen?
254 android  eclipse  adt  javadoc 

3
Javadoc-Link zur Methode in einer anderen Klasse
Derzeit verweise ich mit dieser Javadoc-Syntax auf Methoden in anderen Klassen: @see {@link com.my.package.Class#method()} Und soweit ich aus der Dokumentation verstehe, ist dies der richtige Weg, dies zu tun. Aber jetzt zum lustigen Teil oder frustrierend. Wenn ich dieses Javadoc generiere, erhalte ich zunächst folgenden Fehler: warning - Tag @see:illegal …
238 java  javadoc 

1
Javadoc: package.html oder package-info.java
Was ist die bevorzugte Methode, wenn Sie versuchen, Javadoc-Kommentare auf Paketebene zu erstellen? Wie geht's? package-info.java Vorteile Neuer Nachteile Missbrauch einer Klasse - Klassen sind für Code gedacht, nicht nur für Kommentare package.html Vorteile HTML-Erweiterung bedeutet, dass es kein Code ist Syntaxhervorhebung in IDEs / Texteditoren Nachteile Keiner? Für mich …
230 java  javadoc 







17
Holen Sie sich Quell-JAR-Dateien, die an Eclipse für von Maven verwaltete Abhängigkeiten angehängt sind
Ich verwende Maven (und die Maven Eclipse-Integration), um die Abhängigkeiten für meine Java-Projekte in Eclipse zu verwalten. Die automatische Download-Funktion für JAR-Dateien aus den Maven-Repositories spart Zeit. Leider enthält es keine API-Dokumentation und keinen Quellcode. Wie kann ich Maven so einrichten, dass automatisch auch die Quell- und Javadoc-Anhänge abgerufen und …
176 eclipse  maven-2  javadoc 

Durch die Nutzung unserer Website bestätigen Sie, dass Sie unsere Cookie-Richtlinie und Datenschutzrichtlinie gelesen und verstanden haben.
Licensed under cc by-sa 3.0 with attribution required.