javadoc的语法高亮?

目前我使用PRE标签在我的javadoc中格式化代码示例,例如:

/** * Example javadoc * 
 String foo = "bar"; 

* * @return true if the operation completed */

但是在生成的javadoc中,这看起来相当单调乏味,我更倾向于使用类似于SyntaxHighlighter的语法突出显示。

如何才能做到这一点?

您可以使用jQuery来使用beautyOfCode插件完成它。 我不确定是否有一种简单的方法来挂钩javadoc生成,但事后你可以在你的标题中执行以下操作:

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

并且PRE标签内的所有文本都将突出显示为java。 查看上面的链接以获取更多信息。

另一个选择是使用pegdown-doclet ,它允许你使用Github风格的fenced代码块。

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

迟到总比不到好。

我的答案解释了 – 尽管它的标题 – 如何使用SyntaxHighlighter作为OP请求为您的Javadocs添加语法突出显示function。

答案假设您正在使用Maven,但它的好处是您的所有项目都将自动inheritance在Javadoc中进行语法突出显示的function。 您不必为每个项目执行此操作。 使用此配方,您无需在每个项目中执行此function。

此外,如果您想进行样式自定义(即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