The OpenNET Project / Index page

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



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

Исходное сообщение
"Доступен консольный файловый менеджер nnn 4.0"
Отправлено боня, 18-Апр-21 15:28 
> Твои знания давно устарели. Мода на "самодокументирующийся код" была модномолодежный десять лет назад.

Это не мода, это норма. Не надо выдавать желаемое за действительность.

Зачем писать комментарий если можно написать тест?
Если вы написали комментарий, а код вокруг него поменялся, что с ним делать?
Где надо писать комментарии, а где не надо писать комментарии? Как уловить эту тонкую грань?
Что делать если комментарий вроде есть, но он понятен только его автору и не вносит ясности?

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

И да, на моей практике не было ни одного случая, когда комментарий нельзя было убрать.

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

Комментарии плохой код не исправляют, скорее наоборот, в плохом коде плохие комментарии.

 

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



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

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