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.


2
Gibt es ein Javadoc-Tag zum Dokumentieren generischer Typparameter?
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 /** * @typeparam T This describes my type parameter …
165 java  javadoc 


4
Android Studio: Javadoc ist beim Hover leer
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+ Shift+ verwende Space, wird die Dokumentation korrekt …

7
Ändern Sie die Autorenvorlage in Android Studio
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? Ich …


11
gutes Beispiel für Javadoc [geschlossen]
Geschlossen. Diese Frage entspricht nicht den Richtlinien für Stapelüberlauf . Derzeit werden keine Antworten akzeptiert. Möchten Sie diese Frage verbessern? Aktualisieren Sie die Frage so dass es beim Thema für Stack - Überlauf. Geschlossen vor 3 Jahren . Verbessere diese Frage Gibt es ein gutes Beispiel für eine Quelldatei, die …
140 java  javadoc 

14
Einfache Getter / Setter-Kommentare
Welche Konvention verwenden Sie, um Getter und Setter zu kommentieren? Das habe ich mir schon seit einiger Zeit gefragt: /** * (1a) what do you put here? * @param salary (1b) what do you put here? */ public void setSalary(float salary); /* * (2a) what do you put here? * …


3
Wie man mit Javadoc einen @ Link zu einem Enum-Wert erstellt
Mit Javadoc 1.5 konnte ich keinen @link zu einem Aufzählungswert erstellen. Was ich tun möchte, ist eine Aufzählung wie diese zu erstellen: public enum Planet { /** * MERCURY is a fun place. */ MERCURY, /** * VENUS is more fun. */ VENUS, /** * But nothing beats the Earth. …
120 java  javadoc 


3
Intellij IDEA zeigt Javadoc automatisch an
Wenn ich bei Netbeans codiere, wird der Code automatisch vervollständigt und Javadocs angezeigt. Wenn ich jedoch Intellij IDEA verwende, wenn ich auf Ctrl+Space klicke, kann ich die automatische Vervollständigung sehen, und wenn ich auf Ctrl+Q klicke, kann ich den Javadoc separat sehen. Ist es möglich, das Javadoc-Element zu sehen, wenn …

3
Netbeans: wie man @author ändert
Beim Erstellen einer neuen Klasse oder Schnittstelle in Netbeans IDE wird das Tag "@author ...." angezeigt. Wie kann man seinen Wert ändern? Wenn möglich, möchte ich es ändern, indem ich das Netbeans-Menü verwende und nicht einige Konfigurationsdateien bearbeite :) Ich verwende Netbeans 7.2

4
Verwendung von @see in JavaDoc?
Wann verwende ich @seebeim Umgang mit JavaDocs? Was ist seine Verwendung? Zum Beispiel , wenn MethodAAnrufe MethodBtun , dann muss ich setzen @seein MethodB‚s javadoc und Referenz , MethodAweil das , was sie genannt wird, oder muss ich einen Verweis setzen MethodBaus , MethodAweil sie es anruft. Ich habe das …
110 java  methods  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.