Главная Случайная страница Контакты | Мы поможем в написании вашей работы! | ||
|
Иногда бывает полезно оставить заметки «на будущее» в форме комментариев //TODO. В следующем примере комментарий TODO объясняет, почему функция имеет вырожденную реализацию и что она должна делать в будущем.
// T0D0 - На данный момент эта функция не используется.
// Ситуация изменится при переходе к отладочной модели.
protected Versionlnfo makeVersionO throws Exception
{
return null;
}
Комментарии TODO напоминают о том, что, по мнению программиста, сделать необходимо, но по какой-то причине нельзя сделать прямо сейчас. Например, комментарий может напомнить о необходимости удаления устаревшей функции или предложить кому-то другому поучаствовать в решении проблемы — скажем, придумать более удачное имя или внести изменения, зависящие от запланированного события. Впрочем, чем бы ни был комментарий TODO, это не повод оставлять плохой код в системе.
В наши дни в любой хорошей рабочей среде имеется функция поиска всех комментариев TODO, так что потеря таких комментариев маловероятна. И все же код не должен загромождаться лишними комментариями TODO. Регулярно просматривайте их и удаляйте те, которые потеряли актуальность.
8. Комментарии. Основные признаки плохих комментариев. Примеры.
Дата публикования: 2015-01-26; Прочитано: 296 | Нарушение авторского права страницы | Мы поможем в написании вашей работы!