javadoc的语法高亮？

Question

目前我在我的javadoc中使用PRE标签格式化代码示例，例如： 但是这在结果javadoc中看起来相当单调和无聊，我宁愿有一些类似于 的语法高亮。 如何做到这一点？

Answer 1

您可以使用jQuery使用beautyOfCode插件来完成。我不知道是否有挂接到Javadoc生成一个简单的方法，但后 - 事实上，你可以做你的头以下：

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

和PRE标签内的所有文本会被高亮为java的。查看以上链接了解更多信息。

Answer 2

比从未更好的迟到。

这个answer由我解释 - 尽管它的标题 - 如何使用SyntaxHighlighter作为OP请求添加语法高亮功能到您的Javadocs。

答案假设您正在使用Maven但它有所有您的项目将自动继承做语法高亮显示的Javadoc能力的好处。你会而不是必须为每个项目做到这一点。使用这个配方，您无需在每个项目中执行该功能。

此外，如果您想进行样式自定义（即您的Javadoc的外观），您将使用相同的机制。

Answer 3

找到这个问题寻找其他的东西。在此期间我写了一个工具嵌入要点样品到的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

Answer 4

另一种选择是使用pegdown-doclet，它可以让你使用Github风格的围栏代码块。

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