В настоящее время I примеры кода формата в моем Javadoc используя PRE тег т.д .:подсветка синтаксиса для javadoc?
/**
* Example javadoc
*
<pre>
String foo = "bar";
</pre>
*
* @return true if the operation completed
*/
Но это оказывается скорее монотонные и скучный в результате Javadoc, я бы предпочел иметь некоторый подсвечивает синтаксис похож на SyntaxHighlighter.
Как это можно сделать?
Вы можете использовать jQuery, чтобы сделать это, используя плагин beautyOfCode. Я не уверен, если есть простой способ подключить в поколение JavaDoc, но после того, как-фактум, вы можете просто сделать следующее в вашем заголовке:
$(function(){
$("pre").beautifyCode('java');
});
и весь текст внутри PRE тегов будут выделена в качестве Ява. Ознакомьтесь с приведенными выше ссылками для получения дополнительной информации.
Лучше поздно, чем никогда.
answer Мне объясняется - несмотря на его название - как добавить функцию подсветки синтаксиса к вашим Javadocs, используя SyntaxHighlighter в качестве запросов OP.
Ответ предполагает, что вы используете Maven но имеет то преимущество, что все ваши проекты будут автоматически наследуют способность делать подсветку синтаксиса в Javadoc. Вы должны не должны сделать это для каждого проекта. С помощью этого рецепта вам нечего делать в каждом проекте, чтобы иметь эту функцию.
Кроме того, это тот же механизм, который вы использовали бы, если бы хотели сделать настройки стиля (то есть, как выглядит ваш Javadoc).
Обнаружил этот вопрос, ища что-то еще. В промежутке я написал инструмент, который встраивает GIST образцы в JavaDoc в: https://www.codenameone.com/blog/javadoc-source-samples-that-dont-suck.html
Вы можете увидеть это используется в коде, например: https://www.codenameone.com/javadoc/com/codename1/components/MediaPlayer.html
https://www.codenameone.com/javadoc/com/codename1/ui/package-summary.html
Другой вариант заключается в использовании pegdown-doclet, который позволяет вы используете блокированные кодовые блоки в стиле Github.
```java
public static class Example {}
```