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

какие же вы найдете в визуальной студии? (visual studio 2010 → среда → список задач → токены)

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

  • HACK - низкий
  • ОБЗОР - высокий
  • TODO - обычный
  • WTF - высокий

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

используете ли вы какие-либо другие?

Вы покрываете любую другую важную вещь с помощью токенов комментариев?

какие-либо рекомендации? Thnx

Ответы

Ответ 1

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

  • TODO: функциональность еще не реализована.
  • FIXME: код должен быть изменен/реорганизован для достижения определенной цели (более высокая ремонтопригодность, более высокая производительность и т.д.).
  • ОШИБКА: код имеет известную ошибку

Ответ 2

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

 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 going on. This is gives a higher profile to standard comments, and allows notes to be found in the to-do pane.

Ответ 3

Другой встроенный - ПРИМЕЧАНИЕ.

Ответ 4

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

Ответ 5

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

Sun (старые) соглашения о кодировании Java имеют это сказать:

Используйте XXX в комментарии, чтобы отметить что-то фиктивное, но работает. Используйте FIXME, чтобы обозначить что-то фиктивное и сломанное.