Как процитировать «* /» в JavaDocs

Мне нужно включить */ в мой комментарий JavaDoc. Проблема в том, что это тоже такая же последовательность для закрытия комментария. Какой правильный способ процитировать / избежать этого?

Пример:

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

Последующие действия : похоже, я могу использовать / для косой черты. Единственным недостатком является то, что это не все, что можно прочитать при просмотре кода непосредственно в текстовом редакторе.

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

Используйте экранирование HTML.

Итак, в вашем примере:

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

/ экранируется как символ «/».

Javadoc должен вставлять escape-последовательность без изменений в HTML-код, который он создает, и который должен отображаться как «* /» в вашем браузере.

Если вы хотите быть очень осторожным, вы можете избежать обоих символов: */ переводит на */

Редактировать:

Последующие действия: похоже, я могу использовать & # 47; для косой черты. Единственным недостатком является то, что это не все, что можно прочитать, когда просматривайте код напрямую.

Так? Дело не в том, что ваш код читается, дело в том, что ваша документация по коду должна быть читаемой. Большинство комментариев Javadoc встраивают сложный HTML для объяснения. Ад, эквивалент C # предлагает полную библиотеку тегов XML. Я видел там довольно сложные структуры, позвольте мне рассказать вам.

Редактирование 2: Если это вас слишком беспокоит, вы можете включить встроенный комментарий, не содержащий javadoc, который объясняет кодировку:

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

Это «правильное» решение, но для удобства читаемости я бы, вероятно, пошел:

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

Никто не упомянул {@literal} . Это еще один способ:

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

К сожалению, вы не можете избежать */ за раз. С некоторыми недостатками это также фиксирует:

Единственным недостатком является то, что это не все, что можно прочитать при просмотре кода непосредственно в текстовом редакторе.

Использовать объект

 */ 

В вашей документации он будет отображаться как «* /»,

Я бы посоветовал вам добавить комментарий, где-то рядом, говоря что-то вроде

 // */ is html for */ 

Другой способ, на который я наткнулся, просто для полноты: добавить некоторую HTML-разметку, которая не изменяет вывод между * и /.

  /** * */ */ 

По сравнению с решением для удаления HTML это кажется чем-то вроде уродливого взлома, но также дает правильный результат в HTML-выходе.

  • Как прокомментировать блок тегов в XML?
  • Давайте будем гением компьютера.