2016-11-10 3 views
0

Я довольно новичок в IntelliJ.IntelliJ JavaDoc @see

My IntelliJ не выделяет @see в комментариях. Похоже, IntelliJ не видит @see как ключевое слово JavaDoc, но я не могу понять, как это изменить.

Это нормально или я могу исправить эту проблему?

enter image description here

+0

Пожалуйста, покажите комментарий к документу, который не подсвечен, как вы ожидаете. – yole

+0

Хорошо. Я добавил скриншот. Я ожидал выделить как @author – Highchiller

ответ

1

Это, как ожидается. @see - это тег блока. Это должно быть в начале строки. См. the documentation

Тег - специальное ключевое слово в комментарии к документации, которое обрабатывает команда javadoc. Существует два типа тегов: блок-теги, которые отображаются как тег @tag (также называемые автономными тегами) и встроенные теги, которые отображаются в фигурных скобках, как тег {@tag}. Чтобы интерпретироваться, тег блока должен появиться в начале строки, игнорируя ведущие звездочки, пробел и разделитель (/ **). Это означает, что вы можете использовать символ @ в другом месте в тексте, и это не будет интерпретироваться как начало тега.

(курсив мой)

Ваш комментарий, если цель состоит в том, чтобы создать ссылку на GlobalConstants класса, должны быть

Take a look at {@link GlobalConstants} 

IntelliJ будет генерировать, что для вас, если вы просто введите GlobalConstants и нажмите Ctrl-space (или Cmd-Space).

Смежные вопросы