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.
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...
Etwas wie: /** * See {@linktourl http://google.com}
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")); *...
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...
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...
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...
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...
Kann ich in Android Studio Tastenkombinationen verwenden, um Javadoc-Kommentare zu generieren? Wenn nicht, was ist der einfachste Weg, um Javadoc-Kommentare zu
Was ist der Unterschied zwischen /** * comment * * */ und /* * * comment * */ in Java? Wann soll ich sie
Könnte mir jemand den Unterschied zwischen Javadoc @seeund Javadoc sagen {@link}? Oder eher, wann welche davon zu verwenden
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...
In den Java-APIs kann ich Javadoc-Kommentare für Pakete sehen. Wie / wo platziere ich Javadoc-Kommentare, um ein Paket zu
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- @Sequenz ausprobiert , aber das hat nicht
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...
Ich habe die Javadoc-Dokumentation auf der Sun-Website durchgesehen und versucht, herauszufinden, ob es ein Javadoc-Tag gibt, mit dem die generische Typensignatur einer Klasse oder Methode dokumentiert werden kann. So etwas wie @typeparamdas Übliche @param, aber anwendbar auf Typen und Methoden, z...
Ich habe solche Kommentare im Javadoc-Stil in den Code meines Projekts geschrieben: /** * Description... * * @param ... * @return ..... */ Wie kann ich Javadoc-HTML-Dateien mit der Eclipse-IDE
Geschlossen . Diese Frage basiert auf Meinungen . Derzeit werden keine Antworten akzeptiert. Möchten Sie diese Frage verbessern? Aktualisieren Sie die Frage, damit sie mit Fakten und Zitaten beantwortet werden kann, indem Sie diesen Beitrag bearbeiten .
Ich bin kürzlich von Eclipse zu Android Studio gewechselt und mag es. Ich vermisse jedoch die Javadoc on Hover-Funktion von Eclipse. Ich habe die Anweisungen hier befolgt , um die Funktionalität hinzuzufügen. Meine Hover enthalten jedoch kein Javadoc. Wenn ich meine Dokumentationsverknüpfung Ctrl+...
Ich möchte den automatischen Autor ändern, der angezeigt wird, wenn ich eine Datei in AndroidStudio erstelle. /** * Created by a556520 on 16/01/14. */ public class POI { Der Autor nimmt 'a556520', aber ich möchte, dass mein Name und nicht die Anzahl der Mitarbeiter angezeigt wird. Ist das möglich?...
In Eclipse kann ich Alt+ Shift+ drücken Jund einen Javadoc-Kommentar erhalten, der automatisch mit Feldern, Rückgaben oder was auch immer für diesen bestimmten Javadoc-Kommentar zutreffen würde. Ich gehe davon aus, dass IntelliJ IDEA diese Funktion hat. Kann mir jemand sagen, ob es dafür eine...