Подсветка синтаксиса для javadoc?

В настоящее время я форматирует примеры кода в своем javadoc, используя тег PRE, например:

/**
 * Example javadoc
 * 
<pre>
String foo = "bar";
</pre>
 *
 * @return   true if the operation completed
 */

Но это получается довольно монотонно и скучно в результате javadoc, я бы предпочел бы подсветку синтаксиса, похожую на SyntaxHighlighter.

Как это можно сделать?

Ответы

Ответ 1

Вы можете использовать jQuery, чтобы сделать это, используя beautyOfCode. Я не уверен, есть ли простой способ подключиться к генерации javadoc, но после этого вы можете просто сделать следующее в своем заголовке:

$(function(){  
    $("pre").beautifyCode('java');  
});

и весь текст внутри тегов PRE будет выделен как java. Ознакомьтесь с приведенными выше ссылками для получения дополнительной информации.

Ответ 2

Другой вариант - использовать pegdown-doclet, который позволяет использовать защищенные блоки кода в стиле Github.

```java
public static class Example {}
```

Ответ 3

Лучше поздно, чем никогда.

Этот ответ объясняет мне - несмотря на его название - как добавить функцию подсветки синтаксиса к вашим Javadocs, используя SyntaxHighlighter в качестве запросов OP.

Ответ предполагает, что вы используете Maven, но это имеет то преимущество, что все ваши проекты автоматически наследуют возможность синтаксиса выделение в Джавадоке. Вам не придется делать это для каждого проекта. С помощью этого рецепта вам нечего делать в каждом проекте, чтобы иметь эту функцию.

Кроме того, это тот же механизм, который вы использовали бы, если бы вы хотели сделать настройки стиля (т.е. как выглядит ваш Javadoc).

Ответ 4

Нашел этот вопрос, ища что-то еще. В промежутке я написал инструмент, который вставляет образцы 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