Во время написания кода очень часто возникает ситуация, когда вы заметили какой-либо недочёт в коде, который не настолько критичен, чтобы править его прямо сейчас, но очень желательно исправить его в будущем. Чтобы потом о них не забыть, в таких местах можно оставлять комментарии, предваряя их токеном TODO с двоеточием:
// TODO: здесь требуется оптимизировать код
Тогда все комментарии, в начале которых стоит TODO, будут выводиться в одном окне Task List. Для отображения таких комментариев в выпадающем списке в этом окне выберите "Comments".
Комментарии из всех файлов проекта будут собираться в одном месте. Двойной клик на любой из строк в этом списке тут же переносит вас в соответствующее место в коде. Эдакий план разработки, если нет других более приоритетных задач.
Кроме TODO можно использовать и другие токены. Выберите в Visual Studio меню Tools - Options - Environment - Task List. Там вы увидите список всех доступных по умолчанию токенов, а также сможете добавить свои. Для каждого токена можно задать один из трёх приоритетов (имеет смысл при большом количестве комментариев): низкий (в списке будет отображаться как синяя стрелка вниз), средний (никакой пиктограммы не отображается) и высокий (красный восклицательный знак).
Хочу заметить, что подобный функционал поддерживает любая современная среда разработки, будь то Eclipse или IntelliJ Idea. Причём бывает даже не обязательно писать todo заглавными буквами и не требуется ставить двоеточие.
// todo исправить в ближайшее время
А вообще, старайтесь избегать разрастания списка todo комментариев. Обширные их списки могут демотивировать вас. Вместо того, чтобы написать такой комент, лучше попытайтесь его тут же исправить.
// TODO: здесь требуется оптимизировать код
Тогда все комментарии, в начале которых стоит TODO, будут выводиться в одном окне Task List. Для отображения таких комментариев в выпадающем списке в этом окне выберите "Comments".
Комментарии из всех файлов проекта будут собираться в одном месте. Двойной клик на любой из строк в этом списке тут же переносит вас в соответствующее место в коде. Эдакий план разработки, если нет других более приоритетных задач.
Кроме TODO можно использовать и другие токены. Выберите в Visual Studio меню Tools - Options - Environment - Task List. Там вы увидите список всех доступных по умолчанию токенов, а также сможете добавить свои. Для каждого токена можно задать один из трёх приоритетов (имеет смысл при большом количестве комментариев): низкий (в списке будет отображаться как синяя стрелка вниз), средний (никакой пиктограммы не отображается) и высокий (красный восклицательный знак).
Хочу заметить, что подобный функционал поддерживает любая современная среда разработки, будь то Eclipse или IntelliJ Idea. Причём бывает даже не обязательно писать todo заглавными буквами и не требуется ставить двоеточие.
// todo исправить в ближайшее время
А вообще, старайтесь избегать разрастания списка todo комментариев. Обширные их списки могут демотивировать вас. Вместо того, чтобы написать такой комент, лучше попытайтесь его тут же исправить.
Комментариев нет:
Отправить комментарий