Actuellement, j'ai format des exemples de code dans mon javadoc en utilisant la tag prédéfinie, par exemple:
/** * Example javadoc * <pre> String foo = "bar"; </pre> * * @return true if the operation completed */
5 Réponses :
Vous pouvez utiliser JQuery pour le faire en utilisant le Beautyofcode Plugin. Je ne sais pas s'il y a un moyen facile de se connecter à la génération Javadoc, mais après-la-fait, vous pouvez simplement faire ce qui suit dans votre en-tête: et tout texte à l'intérieur des étiquettes précédentes sera mis en évidence comme Java. Consultez les liens ci-dessus pour plus d'informations.
mieux en retard que jamais.
Ce répondez par moi explique - malgré son titre - malgré son titre - Comment ajouter une fonctionnalité de surbrillance de la syntaxe sur vos Javadocs à l'aide de SyntaxHighLighter comme demande OP.
La réponse suppose que vous utilisez Maven mais il a le profit que tous Vos projets hériteront automatiquement de la possibilité de faire la sélection de la syntaxe dans Javadoc. Vous allez pas dois le faire pour chaque projet. Avec cette recette, vous n'avez rien à faire dans chaque projet pour avoir la fonctionnalité.
En outre, il s'agit du même mécanisme que vous utiliseriez si vous vouliez faire des personnalisations de style (c'est-à-dire comment votre javadoc regarde).
a trouvé cette question à la recherche de quelque chose d'autre. Dans l'intervalle, j'ai écrit un outil qui intègre des échantillons de gis dans Javadoc dans: https://www.codenameone.com/blog/javadoc-source-samples-that-dont-suck.html
Vous pouvez voir ceci utilisé dans notre code E.g.: https://www.codenameone.com/javadoc/com/codename1/components /Mediaplayer.html
https://www.codenameone.com/javadoc/ com / codename1 / ui / paquet-sommaire.html
Une autre option consiste à utiliser Pegdown-Doclet Code> , qui permet Vous utilisez des blocs de code clôturés de style GITUB.
```java
public static class Example {}
```
Les autres réponses ici tout le travail, mais introduire des dépendances supplémentaires ou ajouter de la complexité de construction supplémentaire. Si vous utilisez Maven pour générer les documents, et que vous voulez la façon la plus simple d'obtenir ce travail sans fichiers supplémentaires ou des dépendances, puis ajouter au maven-plugin-javadoc code> config: /**
* Does something cool.
* <pre><code class="java">{@code
// some example code here
int x = 5;
* }</code></pre>
*/