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

Итак, я только недавно обнаружил комментарий 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. Их цель - помочь с развитием в конце концов..

Ответ 1

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

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

TODO, FIXME, XXX

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

CHECKME, DOCME, TESTME, PENDING

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

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

Ответ 2

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

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

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

Ответ 3

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

Ответ 4

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