Что делает аннотация @code java

Я попытался выполнить поиск в документации Oracle для объяснения того, что @code аннотация java делает.

Из предыдущего вопроса я понял, что он имеет какое-то отношение к html, но я не уверен, что именно...

Можно ли сказать, что по умолчанию javadoc анализируется как HTML...  Но помещая аннотацию @code рядом с некоторым текстом javadoc, укажет, что ее следует рассматривать как код, а не обрабатывать/визуализировать обычным способом? Так, например:

    /**
    *This is how to declare an int variable {@code int var=1;}
    */

Будет ли это правильным примером его использования?

ОТВЕТЫ

Ответ 1

{@code ...} - это тег Javadoc, который сообщает Javadoc, что текст внутри фигурных скобок является исходным кодом и не должен рассматриваться как HTML. Javadoc также должен форматировать текст в блоке кода иначе, чем другой текст. Это похоже на текст "примера кода", который используется редактором Qaru при форматировании вопроса или ответа.

Javadocs - это специально отформатированные комментарии исходного кода для описаний классов, конструкторов и методов, которые помогают генерировать HTML-документацию об исходном коде. Например, API Java полностью документирован с использованием Javadocs для чтения в Интернете или в IDE. Подробности смотрите в Генераторе документации API Java.

Ответ 2

Если вы хотите добавить JavaDocs для метода. Возможно, вы не знаете, что такое Javadocs

enter image description here

Итак, желтое - это Javadoc здесь Если вы хотите добавить код для метода в качестве Javadoc, вы можете аннотировать его с помощью @code для других, используя метод, чтобы увидеть метод в качестве примера. и почему мы должны использовать его, потому что, если мы этого не сделаем, форматирование не будет правильным

Вы можете обратиться к следующему вопросу, если хотите проверить изменения в форматировании, если вы не добавляете @code: Пример нескольких строк в комментарии Javadoc