Ключевые слова комментариев 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. В конце концов, их цель - помочь в развитии ..


eclipse ide comments rubymine todo
person OVERTONE    schedule 06.03.2012    source источник
comment
FIXME: работает аналогично TODO: в vim. Не совсем IDE, но все же ... :)   -  person cHao    schedule 06.03.2012
comment
Могу подтвердить, что FIXME работает и в eclipse. На самом деле звучит неплохо. Это 2: D   -  person OVERTONE    schedule 06.03.2012
comment
Небольшое примечание: оставьте : в конце тегов задач. Многие инструменты добавляют их после определения, что впоследствии вызывает некоторый шум (особенно, если некоторые разработчики используют его, а некоторые нет - например, это немного портит Представление задач в старые сборки Eclipse).   -  person rlegendi    schedule 07.03.2012

Ответы (6)


arrow_upward
77
arrow_downward

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

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

TODO, FIXME, XXX

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

CHECKME, DOCME, TESTME, PENDING

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

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

person rlegendi    schedule 06.03.2012
comment
Я добавил ПРИНЯТИЯ, чтобы зафиксировать неочевидные предварительные условия. - person rimsky; 23.07.2015

arrow_upward
15
arrow_downward

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

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

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

person helloworld922    schedule 06.03.2012

arrow_upward
11
arrow_downward

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

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

person John R Perry    schedule 15.02.2018

arrow_upward
1
arrow_downward

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

person user1242756    schedule 06.03.2012
comment
Я знаю об этом. Я просто искал список общепринятых или значений по умолчанию в промышленной сети. - person OVERTONE; 06.03.2012

arrow_upward
1
arrow_downward

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

person noname noname    schedule 22.10.2014

arrow_upward
1
arrow_downward

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

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

person Rodrigo    schedule 24.02.2018