Ключевые слова комментариев IDE

Question

Так что я только недавно обнаружил комментарий TODO. Для тех из вас, кто не знает, большинство современных IDE распознают это слово в комментарии и помечают строку комментария другим цветом, чтобы она выделялась.

EG.

//Need to talk to Bill about refactoring this code

//TODO:Need to talk to Bill about refactoring this code

Вы можете заметить в IDE, как Eclipse или Rubymine , выделение комментария TODO и некоторые другие приятные функции, связанные с ним.

Мой вопрос: какие еще ключевые слова существуют, например, TODO? Похоже, гораздо лучший способ общения с разработчиками через комментарии и особенность, которая должна быть немного более широко известна в IDE. Их цель, в конце концов, помочь в развитии ..

Answer 1

Я могу говорить об Eclipse, вы можете настроить его.

Нажмите Окно -> Настройки и найдите Общие -> Редакторы -> Редакторы структурированного текста -> Теги задач , или Java -> Компилятор -> Теги задач (могут быть некоторые дополнительные, например, для JavaScript, PHP, StatET и т. Д.)

TODO, FIXME, XXX

Я использую некоторые дополнительные, такие как:

CHECKME, DOCME, TESTME, PENDING

Лично мне нравится использовать теги DISCUSS / REVIEW, чтобы убедиться, что я говорю о какой-то проблеме с кем-то во время обзора кода или парного программирования (например, я не неправильно понял спецификацию, как что-то должно работать и т. Д.) .).

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

Answer 2

Они известны как task tags. В Eclipse они TODO, FIXME и XXX.

Однако Eclipse позволяет вам изменять доступный список тегов задач. Перейти к preferences> Java> Compiler> Task Tags

Здесь вы можете изменить список доступных тегов задач, изменить их приоритет и решить, должны ли теги задач быть чувствительными к регистру.

Answer 3

Чтобы добавить пользовательские теги TODO в IntelliJ , перейдите по адресу:

Настройки> Редактор> TODO

Answer 4

В Eclipse Oxygen 4.7.2 для C / C ++ теги задач настраиваются в Windows -> Настройки -> C / C ++ -> Теги задач.

Вы также можете включить поиск тегов задач в виде ответа @rlegendi.

Answer 5

для включения / выключения средства форматирования кода используйте: // @formatter: on // @formatter: off

Answer 6

Шаблоны типа TODO, FIXME по умолчанию в NetBeans используются в качестве ключевых слов ToDo.Вы также можете добавить любое ключевое слово в Сервис> Параметры> Разное> Задачи.