Ich versuche, eine Anmerkung von {@code} in einen Javadoc-Kommentar mit Netbeans 8.0 einzufügen, und sie funktioniert nicht richtig.
Ich habe schon vorher andere Fragen dazu gesehen (zB Wie können Sie das @ Zeichen in Javadoc entkommen? ), aber die HTML-Escape @ und {@literal @} scheinen beide nicht zu funktionieren.
Mein Kommentar sieht folgendermaßen aus (mit beiden Methoden für das Beispiel):
%Vor% Ich kann Run -> Generate Javadoc treffen und alles läuft ohne Fehler, aber ich sehe das, wenn ich mir die resultierende Ausgabe in einem Browser anschaue:
Was ist nicht das gewünschte Ergebnis ... Irgendwelche Vorschläge / Ideen?
Ich bin ziemlich neu in Java, habe aber in der Vergangenheit Dinge wie Doxygen in C / C ++ benutzt. Mache ich hier etwas falsch? Ich verwende NetBeans 8.0 (Build 201403101706) mit Java 1.8.0_05 x64.
Eine Möglichkeit ist:
%Vor% anstelle von {@code ...} block. Siehe dieses Beispiel Zeile 86.
Dies ist ein bekannter Fehler. Der Link zu dem entsprechenden Fehler lautet:
Ab dem 10.10.2016 gibt es keine geplante Version für einen Fix.
Ich bin gerade jetzt mit NetBeans 8.0.1 auf dieses Problem gestoßen, also habe ich ungefähr 15 Minuten damit herumgespielt. Zuerst mit dem {@code } Formatierer im Javadoc, nichts in den Parens erschien, also hatte ich tatsächliche Brüche im Text im Javadoc. Dann, nachdem wir mit ihm herumgespielt und ihn verändert haben (mit <pre> und ein paar anderen Tags) und andere Klassen geöffnet haben, die {@link } und whatnot haben, hat es einfach angefangen zu arbeiten.
Nicht sicher, was vor sich ging, aber vielleicht brauchte der Javadoc-Renderer der IDE etwas Zeit, um vollständig "aufgewärmt" zu werden. So untechnisch das klingt, so sah es wirklich so aus. Ein javadoc-Header zeigte einen {@code } -Block korrekt, aber keinen weiteren, nur wenige Wörter entfernt. Jetzt werden alle korrekt angezeigt. Ich bin mir nicht sicher, ob das irgendjemandem helfen wird, aber nachdem ich überlegt habe, dass ich ein neues Bugzilla-Ticket an NetBeans senden würde, bin ich wieder da und arbeite. Zurück zu meinen eigenen Tickets ...
Eine Möglichkeit, diesen Fehler zu umgehen, ist die Verwendung eines anderen Zeichens, das dem Standardzeichen "@" ähnelt. Ich habe ein paar Unicode-Zeichen gefunden, die ähnlich sind:
Ich habe versucht, "@Override" mit all diesen in einem Javadoc-Kommentar innerhalb eines Tags {@code ...} zu schreiben. (Ich benutze einen Netbeans-Editor und einen Mozilla Firefox-Browser.) Alle Symbole funktionierten außer für # 1 natürlich. Außerdem erschien # 3 nicht im Editor, aber es funktionierte im Browser gut.