The OpenNET Project / Index page

[ новости /+++ | форум | теги | ]



Индекс форумов
Составление сообщения

Исходное сообщение
"Google опубликовал утилиту для преобразования GIF в анимиров..."
Отправлено Аноним, 15-Июн-18 09:33 
Во-во. Еще, к примеру, код, который ты правишь прямо сейчас, может упоминаться в комментах в абсолютно другом файле: наличие обильных комментариев означает, что тебе нужно не просто править код, но и искать по всему проекту все места, где этот код в комментах хоть как-то упоминается. Изменяешь интерфейс - иди ищи-свищи все комменты, где на него ссылаются. Удалил метод? - поищи, вдруг кто-то в комментах рекомендует его использовать. Самый простой и яркий пример из моей практики: в теле одного метода был вставлен коммент, где упоминался "предыдущий метод", типа:

first () {
}
second () {
  // Зачем нужен этот метод, когда есть предыдущий?
}

Далее другим программистом был вставлен третий метод, аккурат между первым и вторым; таким образом, коммент стал вводить в заблуждение. ИЧСХ, никто себе такой цели не ставил - кого-то обмануть, просто так случилось.

Сопровождение комментариев - работа, которая столь же важна, сколь и работа по сопровождению кода, но на нее никто и никогда специального времени не выделяет, поэтому их лучше не писать вовсе. (А вообще, если по-хорошему, документирование проекта - это работа отдельного сотрудника, технического писателя.)

 

Ваше сообщение
Имя*:
EMail:
Для отправки ответов на email укажите знак ! перед адресом, например, !user@host.ru (!! - не показывать email).
Более тонкая настройка отправки ответов производится в профиле зарегистрированного участника форума.
Заголовок*:
Сообщение*:
 
При общении не допускается: неуважительное отношение к собеседнику, хамство, унизительное обращение, ненормативная лексика, переход на личности, агрессивное поведение, обесценивание собеседника, провоцирование флейма голословными и заведомо ложными заявлениями. Не отвечайте на сообщения, явно нарушающие правила - удаляются не только сами нарушения, но и все ответы на них. Лог модерирования.



Партнёры:
PostgresPro
Inferno Solutions
Hosting by Hoster.ru
Хостинг:

Закладки на сайте
Проследить за страницей
Created 1996-2024 by Maxim Chirkov
Добавить, Поддержать, Вебмастеру