Comment citer “* /” dans JavaDocs

Utilisez le HTML d’échappement.

Donc dans votre exemple:

 /** * Returns true if the specified ssortingng contains "*/". */ public boolean containsSpecialSequence(Ssortingng str) 

/ s’échappe comme un caractère “/”.

Javadoc devrait insérer la séquence échappée non modifiée dans le code HTML qu’elle génère, et cela devrait apparaître sous la forme “* /” dans votre navigateur.

Si vous voulez être très prudent, vous pouvez échapper aux deux caractères: */ traduit à */

Modifier:

Suivi: Il semble que je puisse utiliser & # 47; pour la barre oblique Le seul inconvénient est que ce n’est pas tout à fait lisible lorsque vous visualisez directement le code.

Alors? Le point n’est pas que votre code soit lisible, le but est que votre documentation de code soit lisible. La plupart des commentaires Javadoc incorporent un code HTML complexe à des fins d’explication. Hell, l’équivalent de C # offre une bibliothèque complète de balises XML. J’ai vu des structures assez complexes là-dedans, laissez-moi vous dire.

Edit 2: Si cela vous dérange trop, vous pouvez intégrer un commentaire en ligne non javadoc qui explique l’encodage:

 /** * Returns true if the specified ssortingng contains "*/". */ // returns true if the specified ssortingng contains "*/" public boolean containsSpecialSequence(Ssortingng str) 

 /** * Returns true if the specified ssortingng contains "*/". */ 

C’est la bonne solution, mais pour des raisons de lisibilité, je choisirais probablement:

 /** * Returns true if the ssortingng contains an asterisk followed by slash. */ 

Personne n’a mentionné {@literal} C’est une autre façon de faire:

 /** * Returns true if the specified ssortingng contains "*{@literal /}". */ 

Malheureusement, vous ne pouvez pas échapper */ à la fois. Avec quelques inconvénients, cela corrige également:

Le seul inconvénient est que ce n’est pas tout à fait lisible lors de la visualisation du code directement dans un éditeur de texte.

Utilisez l’entité

 */ 

Dans votre documentation, il apparaîtra comme un “* /”

Je vous suggère également d’append un commentaire de ligne quelque part près de dire quelque chose comme

 // */ is html for */ 

Je suis tombé sur une autre façon, pour être plus complet: ajoutez un balisage HTML qui ne modifie pas la sortie entre * et /.

  /** * */ */ 

Comparé à la solution d’échappement HTML, cela semble être un hack laid, mais cela donne également le bon résultat dans la sortie HTML.