Какие теги вы используете в списке задач (например, Visual Studio 2008)

Question

В нашем коде, мы в настоящее время используют следующие признаки, которые в свою очередь могут быть перечислены в списке задач зрительной студии:

TODO отметить задачи внутри кода необходимость сделать

// TODO: optimize this loop 

HACK маркировать код, который только там, чтобы сделать что-то работу на данный момент, например, для презентации

// HACK: assume we know the users password to skip the need for a popup here 

ОБЗОР пометить часть кода, который был рассмотрен и нуждается в редактировании

// REVIEW: the following method is redundant, use ABC.DEF() instead 

FIXED отметить смотр-codesegments, которые были исправлены, так что рецензент может видеть, что соответствующие изменения произошли.

// REVIEW: the following method is redundant, use ABC.DEF() instead 
// FIXED: removed the method and updated the calls 

Какие еще теги вы используете в своей повседневной работе? Считаете ли вы, что использование тегов (и списка задач) достаточно эффективно для небольших команд (до 10 человек)? Какие другие подходы вы используете для прямого комментирования частей кода?

Answer 1

// SOYLENT: 

Я использую это, чтобы отметить настоящий плохой материал, который требует изменений дизайна.

Answer 2

// I18N 

Я использую этот один, чтобы отметить некоторые детали, которые имеют жёстко строки и нужно обновление «многоязычной» multiculture ... Позже мы опишем те, и убедитесь, что мы извлечь строки или независимо от того, что находится в правильной форме и добавить соответствующие «языковые» вызовы.

Answer 3

Я использую только TODO. Это упрощает жизнь, и они существуют только во время развития. Как только они будут реализованы, они будут удалены. HACKs действительно TODO носят другую шляпу, не так ли?

Я не помещаю остальных в код, поскольку я позволяю subversion управлять своими различиями, а Mantis управляет моим отставанием. Если кто-то хочет сравнить то, что я сделал раньше, тем, что я сейчас делаю в коде, DIFF отлично подходит для этого.

Просто мое мнение. Хороший вопрос.

Answer 4

Я использую только TODO, но у нас есть разные TODO для каждого разработчика в команде, поэтому мы знаем, какие проблемы «наши» (например, я получаю NTODO для того, чтобы Nick's Do Do).

Я также использую HACK в качестве ключевого слова, но больше для поиска просто, как и в

int thisID = list[0].ID; // hack, assume list found a match 

и тому подобное.

Answer 5

Я использую TODO для обозначения кода, который необходимо изменить или добавить, а также для отображения функциональности или кода, который все еще необходимо выполнить, поскольку он часто забывается.

Я использую HACK для определения, когда я использую код, который я хочу изменить или что-то жестко закодированное. Это также указывает на области, в которых мне необходимо провести дополнительные исследования до внедрения.

Answer 6

Мы используем TODO [Инициалы] [Дата], что помогает людям нести ответственность за свои todos.