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


В C # я использую #warning а также #error директивы,

#warning This is dirty code...
#error Fix this before everything explodes!

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


53


источник


Ответы:


Отметьте их // TODO, // HACK или другие токены комментариев, которые будут отображаться в области задач в Visual Studio.

Видеть Использование списка задач ,


76



Тодо тоже комментирует.

Мы также добавили специальное ключевое слово NOCHECKIN, мы добавили фиксацию фиксации в нашу систему управления версиями (очень легко сделать, по крайней мере, cvs или svn), где она сканирует все файлы и отказывается проверять файл, если находит текст NOCHECKIN в любом месте.

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


25



Я использую комбинацию //TODO:  //HACK: а также throw new NotImplementedException(); по моим методам обозначить работу, которая не была выполнена. Кроме того, я добавляю закладки в Visual Studio на незавершенные строки.


13



// TODO: Имя человека - исправьте это.

Это в Java, вы можете посмотреть задачи в Eclipse, которые найдут все ссылки на этот тег и могут группировать их по человеку, чтобы вы могли назначить TODO кому-то другому или посмотреть только на свой собственный.


9



Комментарии «Делать» велики в теории, но не настолько хороши на практике, по крайней мере, в моем опыте. Если вас уволят надолго, чтобы они нуждались в них, то они, как правило, забываются.

Я одобряю общую стратегию Jon T, но обычно я делаю это, просто временно нарушая код - я часто вставляю намеренно неопределенную ссылку на метод и позволяю компилятору напоминать мне о том, что мне нужно, чтобы вернуться к:

PutTheUpdateCodeHere();

6



Если мне нужно бросить все в середине изменения, тогда

#error finish this

Если это то, что я должен сделать позже, оно попадает в мой трекер ошибок (который используется для всех задач).


6



Добавьте тест в отключенное состояние. Они отображаются во всех отчетах о создании.

Если это не работает, я делаю ошибку.

В частности, я не видел, чтобы комментарии TODO когда-либо уменьшались количественно каким-либо значимым образом. Если бы у меня не было времени сделать это, когда я написал комментарий, я не знаю, почему у меня будет время позже.


5