Люди, пишушие код....

Все, что вы хотели знать о программизме, но боялись спросить.
Аватара пользователя
Marmot
Графоман
Сообщения: 39279
Зарегистрирован: 17 фев 2003, 17:58
Откуда: Caulfeild
Контактная информация:

Сообщение Marmot »

El Comandante писал(а):Вопрос (третья попытка) - есть ли общие правила (традиции и тп) ведения внутренней проректной документации. Не отраслевые стандарты, а именно - общепринятые правила???
Общепринятых нету, всё зависит от компании или даже подразделения, если компания большая.
По моему опыту, очень часто документацию пишут те, кому она нужна, а не разработчики.
Процесс этот, как правило, связан с методами допроса граничащими с таковыми запрещёнными Женевской конвенцией :)
Вот что-то типа этого случилось и со мной на той неделе, при подгoтовке к длительным праздникам, когда наши админы вспомнили, что они совсем не преставляют, что делать если мой вычислительный кластер вдруг понадобится перегрузить :)
Ндааа..., а компания у нас ну очень даже не маленькая, и деньги делает на Internet-e...
Аватара пользователя
Ursego
Пользователь
Сообщения: 66
Зарегистрирован: 19 май 2005, 12:42
Откуда: Toronto

Re: Люди, пишушие код....

Сообщение Ursego »

Marmot писал(а):Я лично, предпочитаю self-documented code с правильным и описательными именами модулей, классов, методов и переменных.
Прекрасная практика, но этого не всегда достаточно. Комментарии существуют не для того, чтобы писать что делается (это должно быть ясно из описательных имён), а почему делается - если это не очевидно (а так иногда бывает). Да, можно покопаться и понять, но зачем затруднять себе жизнь, если можно написать пару слов? Я никогда не экономлю на комментариях.
Аватара пользователя
El Comandante
Маньяк
Сообщения: 1124
Зарегистрирован: 31 авг 2004, 15:16
Откуда: VanКУver, BC
Контактная информация:

Сообщение El Comandante »

Спасибо всем за конструктивизм (о как сказал..... :shock: )
А если вы - админ, пишите- скажем скрипт, котрыей есть часть некого проекта, над которым работает куча разных людей. Возможно его будут юзать и править под себя люди из других бранчей. Тогда как?
Русский вариант - буду висет на трубе, бить клаву, но всем все разжую подробно
Альтернативный - останусь на овертайм, за очень дополнительные деньги - все сам переделаю
Вспоминается рассказанная история про электрика на заводе, который слыл незаменимым потому что умел сделать так что асинхронный двигатель начинал крутиться в другую сторону (надо было просто поменять местами две любые фазы) Во время этого шаманства он отгонял вокруг себя народ и накрывался с головой одеялом.
Попрошу не думать что мне просто нескем порепаться, оченно интересно - "how things works" в этой совецкой стране :?
Ответить