Als «javadoc» getaggte Fragen

140
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...

124
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? * @return (2b)...

120
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. */ EARTH, /** *...

120
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...

113
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...

110
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....

93
Wie schreibe ich Javadoc von Eigenschaften?

Ich habe oft ein Dilemma, wenn ich Javadoc für Eigenschaften / Mitglieder einer "einfachen" POJO-Klasse schreibe, die nur Eigenschaften und Getter und Setter enthält (DTO-Stil) .... 1) Schreiben Sie Javadoc für die Eigenschaft oder ... 2) Schreiben Sie Javadoc für den Getter Wenn ich Javadoc...

88
Autocompletion von @author in Intellij

Ich migriere von Eclipse zu Intellij Idea. Eine Sache, die ich noch nicht herausfinden konnte, ist die automatische Vervollständigung des @authorJavaDoc-Tags. Bei der Eingabe @avon Eclipse gibt es zwei Vorschläge: @author - author name @author Wie erreiche ich den ersten Vorschlag in Intellij (ist...

87
Details zum Unterschied zwischen @see und @inheritDoc

Ich habe mir die JavaDoc-Referenz angesehen , und obwohl ich den grundlegenden Unterschied zwischen @see(verschiedenen Links) und {@inheritDoc}(Export von JavaDoc-Kommentaren der Oberklasse) verstehe, muss klargestellt werden, wie die Dinge tatsächlich implementiert wurden. Wenn ich in der...

82
Wie man die individuellen Aufzählungen einer Klasse Javadoc

Ich schreibe das Javadoc für eine Klasse, die ihre eigenen Aufzählungen enthält. Gibt es eine Möglichkeit, Javadoc für die einzelnen Aufzählungen zu generieren? Zum Beispiel habe ich gerade so etwas: /** * This documents "HairColor" */ private static enum HairColor { BLACK, BLONDE, BROWN, OTHER,...

81
Javadoc-Wiederverwendung für überladene Methoden

Ich entwickle eine API mit vielen identisch benannten Methoden, die sich nur durch die Signatur unterscheiden, was meiner Meinung nach ziemlich häufig ist. Sie alle machen dasselbe, außer dass sie verschiedene Werte standardmäßig initialisieren, wenn der Benutzer dies nicht angeben möchte....

81
Javadoc: Zeilenumbrüche ohne HTML-Tags?

Entschuldigung für eine wahrscheinliche FAQ-Frage, aber ich kann die Antwort einfach nicht finden. Soweit ich mich an Eclipse erinnere, wird eine leere Zeile in einem Javadoc-Kommentar (in Javadoc-Popups in der Quelle) als Zeilenumbruch (mit zusätzlichem vertikalen Abstand) angezeigt. In Netbeans...