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 konfigurieren, dass eine Leerzeile als Zeilenumbruch interpretiert wird?
Zusätzliche Frage: Kann ich das Standardverhalten von Netbeans (im Zusammenhang damit) für Javadoc-Popups in der Quelle überschreiben?
Ich spreche von:
Quelle
/**
* Paragraph One
*
* Paragraph Two
*/
void someMethod() { }
Eclipse-Interpretation
Paragraph One
Paragraph Two
Netbeans Interpretation
Paragraph One Paragraph Two
Antworten:
Es hat nichts mit Netbeans zu tun. Ich vermute, Sie sehen sich in einem Fall den Quellcode und in dem anderen die Ausgabe von Javadoc an. Zeilenumbrüche sind in HTML nicht von Bedeutung: Ergo werden sie in der Ausgabe nicht angezeigt . Wenn Sie einen Zeilenumbruch wünschen, verwenden Sie a
<p>
oder a<br>
.quelle
Ich bin mir nicht sicher, ob dies für OPs Fall
<pre></pre>
hilfreich ist , aber ich habe mein Dokument umgelegt, damit NetBean meine Formatierung nicht durcheinander bringt. So wird es aussehen/** * <pre> * Paragraph One * * Paragraph Two * </pre> */
Dies kommt der Anzeige neuer Zeilen im Textformat am nächsten. Ich verwende NetBeans 7.1.2. Auf diese Weise
code format
wird das Dokument mit der Option nicht neu formatiert. Das Anzeigen des Dokuments in Hinweisen ist weiterhin formatiert.Update: In Netbeans 8.x gibt es eine Option für die Code-Formatierung, um die Formatierung von Kommentaren zu deaktivieren.
quelle
In
NetBeans
Version 8.2 wurde bereits eine Option getestet, mit der Sie neue Zeilen in Ihren Kommentaren beibehalten und / oder bei Bedarf ein<p>
Tag zu Ihrem hinzufügenJavadoc
könnenTools
Menü wählenOptions
Editor
Registerkarte und dann zurFormatting
RegisterkarteLanguage
Menü gewähltJava
, und imCategory
Menü gewähltComments
Preserve New Lines
Kontrollkästchen imGeneral
Abschnitt, wenn Sie neue Zeilen in Ihren Kommentaren beibehalten möchten. Dadurch bleiben neue Zeilen erhalten, ohne dass ein<p>
Tag hinzugefügt wirdGenerate "<p>" on Blank Lines
Kontrollkästchen imJavadoc
Abschnitt, wenn Sie auch ein<p>
Tag hinzufügen möchten .quelle
<p>
von Hand gibt, kann es manchmal<p>``<p>
beim ersten Mal doppelt so viel hinzufügen . Danach funktioniert es wie erwartet.Ich stimme Ihnen zu, HTML gehört nicht in den Quellcode. Leider fand ich nicht viel Hilfe beim Googeln. Es ist eigentlich ganz einfach zu implementieren.
Hier ist das benutzerdefinierte Doclet, das Sie kompilieren und verwenden können:
import com.sun.javadoc.*; import com.sun.tools.doclets.standard.*; /** * Formats text-only comments with HTML. */ @SuppressWarnings("restriction") public final class TextDoclet { private static final Pattern NEWLINE_REGEX = Pattern.compile("\\n"); private static final String BR = "<br/>\n"; public static boolean start(RootDoc rootDoc) { for ( ClassDoc classdoc : rootDoc.classes()) classdoc.setRawCommentText(formatText(classdoc.getRawCommentText())); return Standard.start(rootDoc); } private static String formatText(String text) { return NEWLINE_REGEX.matcher(text).replaceAll(BR); } }
Ein Beispiel für das Aufrufen mit javadoc:
javadoc -docletpath ~/project/text-doclet/target/text-doclet-1.0.0-SNAPSHOT.jar -doclet com.myorg.textdoclet.TextDoclet -sourcepath ~/project/myapp/src/main/java -subpackages com.myorg.myapp
quelle
JavaDoc zeigt an, wie die CSS-Stile definiert wurden. Sie können die mit Absatz-Tags verknüpften CSS-Stile folgendermaßen bearbeiten:
quelle
Dies ist eine Pseudolösung
(die leider nur generiertes Javadoc betrifft, aber nicht die In-Source-Javadoc-Anzeige von Netbeans).
Geben Sie ein Stylesheet an, das Folgendes enthält:
quelle
Ich habe keine Ahnung, was Eclipse hier tut, aber wenn Sie dieses Verhalten im Allgemeinen (nicht nur eine IDE) möchten, müssen Sie möglicherweise stattdessen ein neues Doclet erstellen (das möglicherweise auf dem Standard-HTML-Doclet basiert) und dort ein
<p>
at einfügen jede leere Zeile oder so.quelle