О комментариях в текстах программ

← →
wHammer © (2003-01-31 08:32) [0]

Вчера получил название своих приложений на Delphi для работы с БД, дословно – “шалабашки, написал и отвязался”, так сказал мой начальник, упертый 1С’овиц, который ранее (до 1998-99 гг.) до того, как перешёл на 1С писал что-то на Clipper’e, остальные языки, в моем понимании, ему не ведомы. «Шалабашками» мои программы являются по той причине, что в них не содержится комментариев. А все почему? В отделе я практически один пишу на Delphi (а также на C++ и 1С (куда ж без него?)). В январе я взял отпуск, а мою трубку отключили за отсутствием средств на счете, вследствие чего моему начальству до меня было не дозвониться и т.д. А тут, как раз возникла необходимость немного доработать программу, если быть точным, вставить 2 строки в тексты модулей и одну строку в ComboBox.Items., затем компилировать (F9), и скопировать exe в общую папку. И что сделал мой начальник? Залез в исходный код программы на моей машине, сунулся, полистал, полазил по формам, но ничего у него не вышло, позвал Зама, тот парень по грамотней, о БД знает достаточно, пишет на Pal’е для Paradox очень длительное время. Общими усилиями, они (начальник ОАСУП и его заместитель), за пол дня все-таки добавили 3 пресловутых строки. После чего я был значительно отруган, назван плохим программистом, которого, дословно “если, не приведи господь, придется работать на западе, будут выкидывать из каждой конторы, потому что в моих программах нет комментариев для их дальнейшего понимания другими программистами”.
Ребят, рассудите, что это, действительно мой непрофессионализм, или уязвленное самолюбие начальства? А также очень хотелось бы узнать, все ли из вас, пишут комментарии в текстах программ?

С наилучшими...
Александр.

← →
Praco © (2003-01-31 09:27) [1]

При групповой разработке необходимо придерживаться общих правил, в т.ч. и в плане комментариев. Я так понимаю, что подобные правила не были разработаны и тебе сообщены, следовательно, виноват начальник и ты ему имеешь полное право сказать: "Сам дурак". Или даже: "Учись программировать, ламмер".

ЗЫ
Учитывая, что он "упертый 1С’овиц", то же самое могу сказать и я, даже не будучи знаком лично.

ЗЫЫ
Лично я комментирую свои исходники довольно обильно. :)

← →
LordOfSilence © (2003-01-31 09:34) [2]

Ну... Лично я бы не рискнул назвать программиста непрофессиональным только на основании того, что он забыл или не захотел добавить комментарии. :)
У меня ситуация похожая. Начальник когда-то давно писал на досовом FoxPro, а потом пересел на 1С. Как 1С-программист он очень сильный. С другой стороны, другие языки программирования ему просто неведомы. Для него недавно стало откровением (я ему поведал для общего развития :), что в системе Windows между окошками бегают всякие разные сообщения. :) Как 1С"овец я слабее его, зато программирую на Delphi, могу и в Builder"e наваять, для него же это потемки. То есть у нас взаимное разделение и понимание, кто что делает и кто что лучше знает. В мой код (ни 1С, ни тем более Delphi) он практически не лезет. Если же он просит что-то подправить в его старом коде, то он садится ненадолго рядом со мной, объясняет минут 5-10, что и как у него работает и говорит, что он хотел бы изменить. Когда же я делаю поправки в его коде, я всегда стараюсь писать после каждой своей строчки примерно следующее: //Худатов А.Н. 45 мартобря никакого года. Перед этим я не удаляю строку его кода, а просто ее комментирую. Таким образом, если он когда-то опять влезет в свой код, он всегда увидит что писал он, и как это дело исправил я.
Я совершенно не стану утверждать что этот подход самый лучший, отнюдь. Но, по крайней мере, у нас никогда не возникало "взаимных наездов". Да и начальник у меня достаточно вменяемый человек, для того чтобы не пороть всякую хрень на пустом месте.
Короче, нормальные человеческие отношения рулят по-любому :))

← →
Jeer © (2003-01-31 09:50) [3]

Для того, чтобы писать сопровождаемые программы хотя бы приближенно соответствующие да хоть тому же ЕСПД, нужны другие усилия,время, люди.
Сейчас на это почти ни у кого времени нет, особенно если это внутрифирменный продукт.

← →
Archon Kazansky © (2003-01-31 09:58) [4]

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

← →
Danilka © (2003-01-31 10:15) [5]

Archon Kazansky © (31.01.03 09:58)

Я тоже. Но уже не один раз наступал на такие грабли, когда надо залезть в код, который писал бог знает когда, и приходится с ним разбираться довольно долго. Комментарии-бы все упростили, но все как-то лень их ставить.

← →
Archon Kazansky © (2003-01-31 11:53) [6]

Danilka © (31.01.03 10:15)

Надо работать над собой. Я уже сегодня аж 3 комментария в
прогу вставил.

← →
passm © (2003-01-31 11:58) [7]

Комментрарии пишу очень редко.
Ну зачем комментарии на процедуры: ReopenDataSet, ReopenDataSetAndLocate, GenerateNewID, SetCurrentAffiliate...
Action"ы: ListWholesaleAction, OpenDocumentAction...
Впрочем, по моим исходникам еще не лазали :)
Если начальник Ламер, то тяжело будет в любом случае. Вспомнился анекдот в тему:
<BEGIN>
Заяц жалуется Медведю, что Волк при каждой встрече его обижает. Говорит:"Почему без шапки!?" И бъет по ушам.
Медведь встретился с Волком и пояснил, что это "нехорошее" поведение. Вот если у Зайца чего-нибудь попросить и у него этого не окажется, то можно и по ушам. Если же найдется, то все равно по ушам - за то что не оказалось не то что нужно.
Из этого вышел следующий диалог:
Волк: - Заяц, дай закурить.
Заяц: - С фильтром или без?
- Дай яблоко.
- Зеленое или красное?
- Почему без шапки!?
И по ушам.
<END>
Когда работал в гос. учреждении, то этот анекдот был актуален, но с начальством над моим непосредственным начальством.

← →
Сергей Суровцев © (2003-01-31 12:45) [8]

Вот интересные вы люди. Начальник - ламер, коментариии - фигня
и т.д. А если бы он не в отпуск ушел, а уволился? Наследство бы
получил? С дуба от любви рухнул? Что, вся контора должна сидеть
и ждать, когда у нашего <ФИО> все наладится, а то и вообще о нем забыть и закрыться? Программу он пишет корпоративную, то есть
ее собственник - компания. И компания в любой момент должна
иметь возможность вести этот проект без него. Никто же не
объясняет бухгалтеру, как считать балансы, инженеру, как
оформлять чертежи и т.д. Специалист, он на то и специалист, что
это все уже ЗНАТЬ ДОЛЖЕН. Вот если для себя дома пишешь, то
это как угодно, хоть все в одну строку.
Ответственнее нужно относиться к своей работе, тем более, когда
от тебя другие люди зависят.
И это еще хорошо, что начальник попался нормальный, пусть за
полдня, но разобрался в чужом проекте, да еще на незнакомом
языке. И всего-то отругал, другой и с зарплаты бы удержал.

← →
Ketmar © (2003-01-31 12:56) [9]

>Сергей Суровцев © (31.01.03 12:45)
ничего подобного. если нет требований к стилю - писать можно так, как удобно. это раз. фиг помогут комментарии, если человек не знает ничего, окромя клиппера и адын-цэ. или придется каждую строку комментировать. это два.

Satanas Nobiscum! 31-Jan-XXXVIII A.S.

← →
Delirium^.Tremens © (2003-01-31 13:10) [10]

>>не_пишущим_комментарии_посвящается
Когда у вас появятся реальные проекты, работа над которыми ведется годами и несколькими разработчиками, вы сможете оценить полезность комментариев. А, вообще, даже в самой вонючей книжке издательства O"Re... говорится, что использование комментариев - признак хорошего тона в программировании.
:-)

← →
Игорь Шевченко © (2003-01-31 13:18) [11]

Ketmar © (31.01.03 12:56)

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

Вот пару раз рублем побьют больно - научится писать комментарии.
Я бы точно побил.

← →
Ketmar © (2003-01-31 14:07) [12]

>Игорь Шевченко © (31.01.03 13:18)
после первого же удара бить стало бы некого. %-)
я аж ни разу не против писать комментарии, если это было чётко оговорено. если мне НЕ СКАЗАЛИ, я понимаю дело так: "пиши как хочешь". и бить стоит как раз того, кто не довел до меня нужные сведения.
в своё время перед тем, как допускать до работы, мне на одной конторе показали пару исходников и дали почитать документ про "корпоративный стиль", принятый у них. и без проблем - соблюдал. но соблюдать то, не знаю что - глупо. я буду писать комментарии, а потом мне скажут, что не надо было. или надо было, но на суахили. или... короче: нет ЦУ - я руководствуюсь своими личными соображениями.

Satanas Nobiscum! 31-Jan-XXXVIII A.S.

← →
wHammer © (2003-01-31 14:33) [13]

to Игорь Шевченко © (31.01.03 13:18)

Вот пару раз рублем побьют больно - научится писать комментарии.
Я бы точно побил.

Меня хоть и не побили, а уволиться уже сильно хочу, и, скорее всего так и сделаю в ближайшем будущем. Слишком неприятный осадок после разговора остался. Хотя есть причины и еще существеннее. Например, 1С, полтора года работаю, но все через силу, никакого удовольствия, совсем не лежит душа после Delphi и проч.

И между тем, как раз за создание этой программы (обсуждаемой) мне премию начальник (тот самый) давал пол года назад, проблема возникла лишь тогда, когда он полез в код и не смог там разобраться. Тогда я и стал плохим программистом.

С наилучшими...
Александр.

← →
Mystic © (2003-01-31 15:12) [14]

> Слишком неприятный осадок после разговора остался

- Вы знаете, больше нам в гости не приходите. после вас у нас серебрянная ложечка пропала.
- Да как Вы, да мы ее не брали!
- Мы это знаем. Мы ее потом нашли. Но неприятный осадок остался.

По поводу коментариев: стараюсь вести TODO-лист, историю версий, принципы работы алгоритмов (нетривиальных) и краткое описание интерфейсных функций. В секции implementation кометариев у меня не много.

← →
Danilka © (2003-01-31 15:39) [15]

Mystic © (31.01.03 15:12)
- Вы знаете, больше нам в гости не приходите. после вас у нас серебрянная ложечка пропала.
- Да как Вы, да мы ее не брали!
- Мы это знаем. Мы ее потом нашли. Но неприятный осадок остался.
:)))

стараюсь вести TODO-лист, историю версий
для истории версий, imho, самое лучшее это CVS-ка.
она-же очень сильно помогает, когда в проекте занято несколько человек.

← →
passm © (2003-01-31 16:55) [16]

Delirium^.Tremens © (31.01.03 13:10)> И много комментариев ты видел в исходниках VCL? ;)

← →
Игорь Шевченко © (2003-01-31 17:00) [17]

passm © (31.01.03 16:55)

К VCL, уважаемый, HELP имеется. Много ли программистов пишут HELP к своему исходному коду ?

← →
Delirium^.Tremens © (2003-01-31 17:02) [18]

passm © (31.01.03 16:55)

> И много комментариев ты видел в исходниках VCL?

Это, надо полагать, должно меня разубедить? Комментарии там есть, хоть и не много. Но методы VCL, кроме того, описаны в HELP.

← →
Delirium^.Tremens © (2003-01-31 17:04) [19]

>>Игорь Шевченко © (31.01.03 17:00)
Я, как Робин Гуд - стрела в стрелу :-)

← →
Сергей Суровцев © (2003-01-31 17:15) [20]

>Ketmar © (31.01.03 12:56)
>ничего подобного. если нет требований к стилю - писать можно >так, как удобно.
А если Вас в гости пригласили, а на стене забыли повесить инструкцию по пользованию ножем и вилкой, руками есть будете? Как удобно?

>фиг помогут комментарии, если человек не знает ничего, окромя
>клиппера и адын-цэ. или придется каждую строку комментировать.
У этого человека может с десяток специалистов быть и все на разных языках, он что, все их знать должен? Или все таки работу
организовывать?

>wHammer © (31.01.03 14:33)
Можно, конечно, и повеситься с горя, но глупо это. Ты пойми, назвал он тебя плохим программистом не потому, что ты плохо сделал дело, а потому, что не довел его до нормального конца. И здесь он, кстати, прав. И не дуться нужно, а извиниться и исправить. Тем более, что премию за это ты уже получил. Поверь, 90% на твоем месте никакой премии и в глаза бы не увидели. Хочешь увольняться, твое право, но дело всегда нужно доделывать до конца. Как говориться: оставляя о себе хорошую память в прошлом ты прокладываешь себе дорогу в будущее.
Кстати, коментарии, это еще что, ты еще Help нормальный не писал.
Вот где мутота жуткая, но ведь тоже надо.
А 1С действительно не подарок. Набор из серии "Сделай сам конфетку из конфетки б.у.".

← →
passm © (2003-01-31 17:18) [21]

Delirium^.Tremens © (31.01.03 17:02)>
Хотите сказать, что вам достаточно Help"а? ;)
Help имеет описательный характер. Назначение функций, классов, их свойств... К комментариям к коду о котором идет речь это, IMHO, не имеет отношения. Если я посмотрю Help FormatDateTime, то он не выдаст инвормацию _как_ работает эта функция. Help предназначен для пользователей Delphi, каковыми мы являемся.
Вы думаете, что разработчики VCL в случае необходимости внести коррективы в исходники руководствуются Help"ом? :)))

← →
Игорь Шевченко © (2003-01-31 17:22) [22]

passm © (31.01.03 17:18)

> Если я посмотрю Help FormatDateTime, то он не выдаст инвормацию
> _как_ работает эта функция

И не надо. Надо, чтобы была известна информация о том, _что_ эта функция делает.
Кстати, исходники VCL написаны хорошо, их и без комментариев понять можно.

Игорь Шевченко © (31.01.03 17:22)>
> Кстати, исходники VCL написаны хорошо, их и без комментариев
> понять можно
Вот и я об этом :)

passm © (31.01.03 17:18)
А какие тебе комментарии нужны. Мне обычно достаточно коротко о назначении процедуры(функции). Если сложная процедура, желательно закомментировать функциональные блоки.

>Сергей Суровцев © (31.01.03 17:15)
>руками есть будете?
с преогромным удовольствием буду есть так, как удобно.

>работу организовывать?
вот-вот. организация работы, по моим понятиям, включает в себя и стандартизацию правил кодинга. и, в том числе, доведение этого стандарта ДО КАЖДОГО кодера. или, по-вашему, все кодеры обязаны быть телепатами? тогда, я полагаю, кодеров на земле катастрофически мало %-)

Satanas Nobiscum! 31-Jan-XXXVIII A.S.

Delirium^.Tremens © (31.01.03 17:26)> Мне обычно о назначении unit"а. Какая форма там содержится, или какого типа функции, константы (типа - это не type :) ).
А функциям и их параметрам даю осмысленные названия.

> в том числе, доведение этого стандарта ДО КАЖДОГО кодера

Розгами на конюшне или рублем. Последнее обычно долее действенно.

Блин, хотел было, читая постинги, сразу писать свое ИМХО, а потом наткнулся на реплику Сергей Суровцев © (31.01.03 12:45) и
Игорь Шевченко © (31.01.03 13:18) и понял, что добавить что-либо весомое вряд ли смогу.
(Я в очередной раз балдею от Сереги, - выражаю свое восхищение ! Но не возгордись..)

А написать вздумал вот по какой причине.

Недавно был сабж Кетмара о поисках работы, который я внимательно прочитал, но высказывать свое мнение не стал. А сейчас надумал.
Уж симпатичен мне это человек. Чувствуется натура - я искренне уважаю таких. Но вот что поражает. Неужели он и такие же как он думают, что работника ценят за его компетенцию ? Действительно, процентов на 40 - ДА. Остальные же 60 - это прежде всего поведение в коллективе, отношение к коллегам и "начальству".
Отсюда и мое полное согласие с Шевченко - лично я не взял бы на работу хоть Кетмара в кубе, если он мне заявит, что "настоящие мужики не пользуются презервативами" или, говоря по-нашему, не пишут комментарии и вообще - исходники, используемые компоненты, библиотеки и т.д. - это его личное дело.
Мало того, что это просто неуважение ко мне как к старшему товарищу (и по возрасту, и по должности), так где гарантия, что такой вундеркинд не свалит через несколько месяцев на место похлебистее и не оставит мне горящий проект с исходниками, написанными без отступов, комментариев, в "своем" фирменном стиле, и я не буду терпеть вполне конкретные убытки, правя тексты или с помощью специально нанятого человека или сам по ночам ? Или просто неполучу с клиента деньги за работу в полном объеме ?
Нет уж, нет уж,-увольте меня от таких крутых кодеров.

>Игорь Шевченко © (31.01.03 17:39)
а дать почитать файл нельзя? надо ждать, пока кодер "облажается", а потом со смаком его пинать? глупо.
Игорь, я же говорил о ситуации, когда кодеру ровным счетом ни о чём не упоминали, а потом предъявляют претензии. ещё раз повторю: глупо сваливать свои ошибки на других. можно остаться без тех, на кого сваливать надо.

Satanas Nobiscum! 31-Jan-XXXVIII A.S.

Ketmar © (31.01.03 17:51)

Ну почему нам так в облом иногда поставить себяна место "начальника" ? Да может он
- думает, что ты сам догадался спросить у коллег о правилах ?
- считает, что ты как чел грамотный все делаешь по стандартам ?
- затрахан в доску своими траблами и сейсас ему не до тебя ?
- просто постеснялся, думая, что этим он тебя обидит ?

>MsGuns © (31.01.03 18:01)
это проблемы начальника. показывающие степень его некомпетентности. по пунктам:
1) я - телепат? когда я прихожу на работу (пусть не программером), о круге своих обязаностей я тоже должен спрашивать у коллег? а босс типа не при чём? смешно, право слово.
2) стандартов много. какой именно используется в данной фирме - я не знаю и знать не могу. повторю: я НЕ ТЕЛЕПАТ.
3) его проблемы. работу-то он будет требовать? а если я ему на требование работы отвечу: "прости, чувак, я сейчас в доску затрахан, и не могу ничего писать"? как вы думаете, долго я на этой работе продержусь? правила - они одни для всех, а не разные для начальства и подчиненных.
4) стесняется пусть в другом месте. он НА РАБОТЕ. и его комплексы к работе отношения не имеют.

Satanas Nobiscum! 31-Jan-XXXVIII A.S.

О комментариях в текстах программ Найти похожие ветки