Токены в визуальной студии: HACK, TODO... любой другой?

Какие токены вы считаете полезными в Visual Studio? (visual studio 2010 → среда → список задач → токены)

В настоящее время у меня есть только:

  • HACK - низкий
  • ОБЗОР - высокий
  • ТОДО - нормально
  • WTF - высокий

(только они - удалены некоторые из них по умолчанию)

Вы используете другие?

Вы покрываете что-то важное с помощью токенов комментариев?

какие-либо лучшие практики? Thnx

Источник

5 ответов

Решение

Вот те, которые я использую:

  • TODO: функциональность еще не реализована
  • ИСПРАВЛЕНИЕ: код должен быть изменен / реорганизован для достижения некоторой цели (более высокая ремонтопригодность, лучшая производительность и т. Д.)
  • BUG: в коде есть известная ошибка
Источник

Я сделал комбинацию из большинства вышеперечисленных токенов.

 RED: code that simply does not work / compile
 // Error - This code is throwing a specific reproducible error.
 // Broken - This code is broken and will not run.
 // WTF - WHAT THE FRIG.

 ORANGE: code that works but is not right
 // Hack - This code has intentionally been hacked in order to work. Should not go into production.
 // FixMe - This code works but could be better. Needs better abstraction, maintainability, performance, etc.
 // Bug - This code works and was expected to be right but a bug has been found. (usually flagged post production)
 // Review - This code is probably right but should be reviewed for piece of mind.
 // Smells - Same as FixMe

 BLUE: code that works but either needs more features or more explaining
 // Todo - Functionality is not yet implemented
 // Note - Better explain what's going on. This is gives a higher profile to standard comments, and allows notes to be found in the to-do pane.
Источник

Мне нравится Token REMOVE, указывающий, что он предназначен только для тестирования и не должен быть включен в финальную версию.

Источник

Еще один встроенный это ПРИМЕЧАНИЕ.

Источник

Vim автоматически выделяет XXX, который, как оказалось, является моим любимым символом для простоты его ввода.

В старых (старых) соглашениях Java по кодированию сказано следующее:

использование XXX в комментарии, чтобы отметить что-то, что является поддельным, но работает. использование FIXME пометить что-то поддельное и сломанное.

Источник
Другие вопросы по тегам