Zur Zeit formatiere ich Code-Beispiele in meinem Javadoc mit dem PRE-Tag, z. B .:
%Vor%Aber das Ergebnis ist ziemlich monoton und langweilig im resultierenden Javadoc, ich hätte lieber eine Syntaxhervorhebung, die SyntaxHighlighter <ähnelt / a>.
Wie kann das gemacht werden?
Sie können jQuery verwenden, um es mit beautyOfCode plugin. Ich bin mir nicht sicher, ob es eine einfache Möglichkeit gibt, sich in die Javadoc-Generation einzuklinken, aber im Nachhinein können Sie in Ihrem Header einfach Folgendes tun:
%Vor%und der gesamte Text innerhalb der PRE-Tags wird als Java hervorgehoben. Weitere Informationen finden Sie unter den obigen Links.
Eine andere Option ist die Verwendung von pegdown-doclet , mit der Sie umzäunte Code-Blöcke im Github-Stil verwenden können.
Besser spät als nie.
Diese Antwort von mir erklärt - trotz seines Titels - wie man Syntax-Highlighter-Funktionen zu Ihren Javadocs hinzufügt, indem Sie SyntaxHighlighter verwenden, wie es das OP verlangt.
Die Antwort geht davon aus, dass Sie Maven verwenden, aber es hat den Vorteil, dass alle Ihre Projekte automatisch ausführen erben die Fähigkeit, Syntax-Hervorhebung in Javadoc zu tun. Sie müssen nicht dies für jedes einzelne Projekt tun. Mit diesem Rezept brauchen Sie in keinem Projekt etwas zu tun, um die Funktion zu haben.
Außerdem ist dies derselbe Mechanismus, den Sie verwenden würden, wenn Sie Stilanpassungen vornehmen möchten (d. h. wie Ihr Javadoc aussieht).
Tags und Links java syntax-highlighting javadoc