Пиджин (pidgin) - это гибридный язык, например русско-английский, который часто встречается в IT-компаниях. На пиджине нижняя часть, показанная на иконах, называется "сниппет кода" (code snippet, фрагмент кода). Сниппеты с комментариями - вот что здесь обсуждается. Избыточные комментарии в коде - это помеха. Они только засоряют рабочее пространство и отвлекают внимание. Если самодокументирующийся код на 50% состоит из комментариев, то при каждодневной копке в таком коде хочется волком выть ))
Чем хорош DRAKON Editor - так это тем, что сниппеты в нём хорошо организованы и выстроены в систему, из которой генерируется полностью готовый и работающий класс кода. При этом есть возможность добавить минималистичные комментарии - и то при необходимости.
Например, как вам понравится такой исходный код? (с точки зрения разработчика)
Цитата:
// В.Д. Паронджанов поблагодарил пользователя Адва
// Также В.Д. Паронджанов сказал, что формулировка хорошая
Адва, спасибо. Хорошо сформулировано.
И так в миллионах строк кода.
1) Если сделать подобное детальное комментирование нормой, то скоуп (scope, объём работ) разрастётся, бюджеты и сроки вырастут. Если бюджеты и сроки не увеличить, то увеличатся риски по суммам и срокам. При нынешней скорости изменений и возможностях рефакторинга можно гарантировать, что те или иные части кода будут регулярно чиститься, удаляться или заменяться. Стоит ли ради этого увеличивать бюджеты и сроки?
2) У кода есть период жизни. Внутри этого периода надо успеть его написать и поэксплуатировать. Полный период жизни кода стремится к сокращению. Период написания и сопровождения, с таким комментированием, скорее всего будет стремиться к увеличению. В итоге - на эксплуатацию кода останется всего-то ничего, с точки зрения времени его существования.
3) Кроме прочего, существует ещё и суровая и жёсткая конкуренция. Такие добавления автоматически увеличивают конкурентные преимущества у других проектов, которые подходят к этим вопросам более прагматично. В результате, наш самодокументируемый проект может завершить своё существование по причине излишнего педантизма.
Это с одной стороны. С другой стороны - у другой целевой аудитории могут быть другие приоритеты.
Вот как выглядит предыдущий фрагмент кода, но с точки зрения другой целевой аудитории:
Цитата:
// В.Д. Паронджанов поблагодарил пользователя Адва
// Также В.Д. Паронджанов сказал, что формулировка хорошая
d#b+, ULWKzVF. 3b~u8d z5)2Y-;#tR:+j@.
Вход
FAQ
Поиск
