Programmierung javadoc

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

5

Verknüpfen mit einer externen URL in Javadoc?

Etwas wie: /** * See {@linktourl http://google.com} */

768 java url javadoc hyperlink

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

4

Wie füge ich einen Verweis auf einen Methodenparameter in Javadoc hinzu?

Gibt es eine Möglichkeit, Verweise auf einen oder mehrere Parameter einer Methode aus dem Methodendokumentationstext hinzuzufügen? Etwas wie: /** * When {@paramref a} is null, we rely on b for the discombobulation. * * @param a this is one of the parameters * @param b another param */ void foo(String …

313 java arguments 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 …

312 java maven migration java-8 javadoc

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

16

So generieren Sie Javadoc-Kommentare in Android Studio

Kann ich in Android Studio Tastenkombinationen verwenden, um Javadoc-Kommentare zu generieren? Wenn nicht, was ist der einfachste Weg, um Javadoc-Kommentare zu generieren?

204 android-studio javadoc

9

/ ** und / * in Java-Kommentaren

Was ist der Unterschied zwischen /** * comment * * */ und /* * * comment * */ in Java? Wann soll ich sie verwenden?

190 java comments javadoc

3

Javadoc @see oder {@link}?

Könnte mir jemand den Unterschied zwischen Javadoc @seeund Javadoc sagen {@link}? Oder eher, wann welche davon zu verwenden sind?

184 java javadoc

5

Codestyle; Javadoc vor oder nach der Annotation setzen?

Ich weiß, dass dies nicht das wichtigste Problem ist, aber ich habe gerade festgestellt, dass ich den Javadoc-Kommentarblock vor oder nach der Anmerkung einfügen kann. Was möchten wir als Codierungsstandard übernehmen? /** * This is a javadoc comment before the annotation */ @Component public class MyClass { @Autowired /** * …

183 java coding-style annotations javadoc code-documentation

3

Wie dokumentiere ich Pakete in Java?

In den Java-APIs kann ich Javadoc-Kommentare für Pakete sehen. Wie / wo platziere ich Javadoc-Kommentare, um ein Paket zu dokumentieren?

182 java packages javadoc

4

Wie können Sie dem @ -Zeichen in Javadoc entkommen?

Wie kann ich dem @Symbol in Javadoc entkommen ? Ich versuche es in einem {@code}Tag zu verwenden, das sich in <pre>Tags befindet. Ich habe bereits die HTML-Escape- &#64;Sequenz ausprobiert , aber das hat nicht funktioniert.

180 java escaping 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

Als «javadoc» getaggte Fragen