actualmente ejemplos de código en formato de mi javadoc usando la etiqueta PRE ej .:resaltado de sintaxis para javadoc?
/**
* Example javadoc
*
<pre>
String foo = "bar";
</pre>
*
* @return true if the operation completed
*/
Pero esto resulta bastante monótona y aburrida en el javadoc resultante, yo preferiría tienen algún formato con colores similares a SyntaxHighlighter.
¿Cómo se puede hacer esto?
Puede usar jQuery para hacerlo usando el plugin beautyOfCode. No estoy seguro de si hay una manera fácil de enganchar en la generación de Javadoc, pero después de los hechos que sólo puede hacer lo siguiente en su cabecera:
$(function(){
$("pre").beautifyCode('java');
});
y todo el texto dentro de las etiquetas PRE será destacado como Java. Mira los enlaces de arriba para más información.
Mejor tarde que nunca.
Este answer me explica, a pesar de su título, cómo agregar la función de resaltado de sintaxis a sus Javadocs utilizando SyntaxHighlighter como las solicitudes de OP.
La respuesta supone que está utilizando Maven pero tiene la ventaja de que todos los sus proyectos heredarán automáticamente la capacidad de hacer resaltar la sintaxis en Javadoc. Usted no tiene que hacer esto para cada proyecto. Con esta receta no hay nada que deba hacer en cada proyecto para tener la función.
Además, este es el mismo mecanismo que usaría si quisiera hacer personalizaciones de estilo (es decir, cómo se ve su Javadoc).
Encontré esta pregunta buscando otra cosa. En el ínterin escribí una herramienta que incorpora muestras GIST en JavaDoc en: https://www.codenameone.com/blog/javadoc-source-samples-that-dont-suck.html
Esto se puede ver utilizado en nuestro código, por ejemplo: https://www.codenameone.com/javadoc/com/codename1/components/MediaPlayer.html
https://www.codenameone.com/javadoc/com/codename1/ui/package-summary.html
Otra opción es utilizar pegdown-doclet, lo que permite usas bloques de código cercados al estilo Github.
```java
public static class Example {}
```