Как заключить в кавычки “* /” в JavaDocs

Question

Как заключить в кавычки “* /” в JavaDocs

В swift интерполяция строк выполняется с помощью \() в строках. Например:

let x = 10
let string = "x equals \(x) and you can also put expressions here \(5*2)"

, поэтому для вашего примера выполните:

var age:Int=1
var pet:String="dog"
lblOutput.text = "Your \(pet) is \(age) years old!"

46

java comments javadoc

задан Steve Kuo 10 March 2009 в 19:15

5 ответов

/**
 * Returns true if the specified string contains "*&#47;".
 */

Это - вЂrightвЂ™ решение, но для пользы удобочитаемости я, вероятно, пошел бы для:

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

7

ответ дан bobince 8 November 2019 в 00:20

Используйте объект

*&#47;

В Вашей документации, которую он разоблачит как "* /"

6

ответ дан cpatrick 8 November 2019 в 00:20

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

// *&#47; is html for */

5

ответ дан hasen 8 November 2019 в 00:20

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

  /**
   * *<b/>/
   */

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

4

ответ дан Jonik 8 November 2019 в 00:20

Другие вопросы по тегам:

java comments javadoc

Похожие вопросы:

score 37 · Accepted Answer

Используйте выход HTML.

Так в Вашем примере:

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

/ Escape как "/" символ.

Javadoc должен вставить завершенную последовательность, в безопасности в HTML, который он генерирует, и это должно представить как "* /" в Вашем браузере.

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

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

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

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

Редактирование 2: , Если это беспокоит Вас слишком много, Вы могли бы встроить non-javadoc встроенный комментарий, который объясняет кодирование:

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