Programmierung javadoc

1

Wie kann ich auf den Wert eines endgültigen statischen Felds in der Klasse verweisen?

Wie kann ich mit JavaDoc auf den Wert eines endgültigen statischen Felds in der Klasse verweisen? Ich möchte das ???in diesem Beispiel durch den Wert des Feldes ersetzen STATIC_FIELD. /** * This is a simple class with only one static field with the value ???. */ public class Simple { …

96 java documentation javadoc

4

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 für die Eigenschaft schreibe, kann …

93 java javadoc

4

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 das überhaupt möglich?)? Und wenn es …

88 intellij-idea javadoc

1

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 Eclipse-IDE "Generate Element Comments" für die geerbte Methode auswähle (von der Schnittstelle oder zum …

87 java javadoc comments

3

Wie erstelle ich in Javadoc mehrere Einrückungsstufen?

Angenommen, Sie möchten im Rahmen der Dokumentation Ihres Codes (Javadoc) angeben, dass die Beziehungen zwischen Elementen mit einem tiefen Einzug versehen sind. Wie kann ich eine verschachtelte Liste erstellen als: irgendein Element ein anderes Element noch ein anderes Element

85 documentation javadoc indentation nested-lists

2

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, RED }; Dies dokumentiert jedoch …

82 java enums javadoc

4

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. Betrachten Sie als verdauliches Beispiel public interface Forest { …

81 java javadoc

7

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 ist dies jedoch nicht der Fall. Kann ich Javadoc so …

81 java netbeans comments javadoc

5

Sollte ich JavaDoc-Verfall oder die Annotation in Java verwenden?

Derzeit gibt es zwei Möglichkeiten, Code in Java als veraltet zu markieren. Über JavaDoc /** * @deprecated */ Oder als Anmerkung: @Deprecated Dies ist mein Problem - ich finde es etwas zu viel, beides zu deklarieren, wenn eine Methode bei Verwendung von Eclipse als veraltet markiert wird. Ich möchte wirklich …

81 java annotations javadoc deprecated

5

Eclipse, wie man ein Glas mit Javadocs / Source mit seiner Binärdatei verknüpft?

Ich möchte, dass die in einer JAR-Datei enthaltenen Javadoc-Kommentare in Eclipse angezeigt werden, wenn ich mit der Maus über eine Klasse fahre. Nach dem Herunterladen von JODA-2.0 werden beispielsweise drei Gläser erhalten: joda-time-2.0 joda-time-2.0-javadoc joda-time-2.0-sources ( http://sourceforge.net/projects/joda-time/files/joda-time/2.0/joda-time-2.0-dist.zip/download ) In Eclipse enthält [Rechtsklick auf Projekt -> Eigenschaften -> Java-Erstellungspfad -> Bibliotheken …

80 java eclipse jar javadoc

12

Gibt es gute und moderne Alternativen zu 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 6 Jahren . Verbessere diese Frage Seien wir ehrlich: Sie müssen kein Designer sein, um …

80 java documentation javadoc

13

Wie füge ich eine Quelle oder JavaDoc in Eclipse für eine JAR-Datei hinzu, z. B. JavaFX?

Derzeit arbeite ich mit JavaFX. Immer wenn ich mit der Maus über eine JavaFX-Methode fahre, wird folgende Fehlermeldung angezeigt: 'Note: This element neither has attached source nor attached Javadoc and hence no Javadoc could be found' Wie soll ich das lösen? Wie kann ich das Javadoc oder die Quelle anhängen, …

79 java eclipse javadoc javafx-2

5

Eclipse Generate Javadoc Wizard: Was ist der Javadoc-Befehl?

Ich möchte die Javadocs für eine Open-Source-Codebasis generieren, die ich verwende. Ich werde jedoch vom Eclipse Generate JavaDoc-Assistenten nach einem "Javadoc-Befehl" gefragt, und die Hilfe erklärt nicht, was dies bedeutet. Will es den Weg zum Javadoc Binary / Jar oder etwas anderes?

72 java eclipse javadoc

3

JDK 11+ und Javadoc

Exit code: 1 - javadoc: error - The code being documented uses packages in the unnamed module, but the packages defined in https://docs.oracle.com/en/java/javase/11/docs/api/ are in named modules. Hat jemand Javadoc zum Laufen gebracht, ohne die Quellversion auf 1.8 ändern zu müssen (wie in anderen Foren vorgeschlagen)? Ich verwende JDK v11.0.5 …

13 java maven javadoc java-11 maven-javadoc-plugin

1

Wie dokumentiere ich Java Record-Parameter?

Wie soll man Java Record Parameter dokumentieren ? Ich beziehe mich auf die Parameter, die letztendlich zu Konstruktorparametern werden, Klassenfeldern. Ich habe es versucht: /** * @param name the name of the animal * @param age the age of the animal */ public record Animal(String name, int age) { } …

12 java intellij-idea javadoc java-14 java-record

Als «javadoc» getaggte Fragen