респект и уважуха франчу "Проект-ИТ" и лично тов. Кучину, за отличное оформление доработок ТиС!

очень редко встречал нормальное документирование во франчах, а тут все раложено по полочкам, отдельная подсистема, везде префиксы, коменты. Ляпота а не база :)

сабж как некое продолжение темы:
v8: Как вы комментируете добавляемый код для избежания проблем с обновлением?

А сколько дали за рекламу?

(0) пришел на новую работу?

(2) угу, разбираюсь
(1) кстати год внедрения 2008, 2009 так-что все могло и изменится во франче

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

из яных кривостей базы - это 6 знаков после запятой в суммах, уж не знаю кто это внедрял, там коментов нет :)

нормальный франч перевел бы на УТ все это безобразие.

(4) была ветка с месяц назад, просто нашел эту...

пример камментов приведи

(8) хочешь взять на вооружение? )

(9) код редко комментирую, а вот справку всегда стараюсь писать

//Проект - ИТ Кучин И.А. Добавлено ==>
   //Дата добавления 2009-01-21
   //Комментарий:  
   ПИТ_Сервер.УдалитьПроведениеРазмещения(Ссылка);
   //<== Кучин И.А.


-------------------------------------------------

//Проект - ИТ Кучин И.А. Добавлено ==>
//Дата добавления 2008-12-11
//Комментарий:
Функция СодатьЕдиницуИзмерения(ЕдиницаИзмерения,БазоваяЕдиницаИзмерения,Номенклатура)

(11) я обычно делаю вида


//вставка+
//поскольку типовой код в данном месте долгий - перепишу его
МойКод();
//вставка-

(5) может быть для курсов валют. бывает внутренний курс с 6 знаками после запятой и потом рублёвые суммы не сходятся

:)
это сродни "Здесь был Вася"

(13) в том числе и это, но там еще и другие траблы из-за знаков есть, например не закрываются регистры (остаток 0.00001 р)

(11)
коментариев то что-то не увидел, а здесь был Вася и я делаю

Блин. Я думал что-то новое увидеть.

Мы и сами так всегда делаем (под угрозой потери куска кода), и приходящих франчей приучили. Изменения ищем по кодовому слову, старый код отключаем, не стирая. Всех появляющихся в конфигураторе учим, даже краткую инструкцию написали.

Нормальные франчи камменты не оставляют... Чтобы потом не спалили авторов копрокода

(0) Какой-то дебильный франч. Всем известно, что нормальный франч - зло и позор 1С.

(19) может еще и сам 1с позор 1с?

народ еще работает с ТиСом
О_о

надеюсь они с теми же методами в снеговика не лезут?

>> СодатьЕдиницуИзмерения

франчи  - позор 1С!1

ну и чего этот камент дает хорошего?

(23) да ничего особого не дает

(0) естественно любой франч будет писать комменты если сдирает с клиента по полнйо программе

(15) то что регистры не закрываются нормально, это мелочи, главное камменты красивые...

(25) бугога

основной прикол получается, если одну и ту же строчку меняют 3-4 раза. И на каждое изменение пишут коммент.

(23) дак и камент то - га*но
// через перенос строки - соответственно плюсиком не "схлапываются"

плюс много бу каф
// ФИРМАФРАНЧ ФИО 25-04-2012 Задача №000009999 <Начало>
// Суть камента

// ФИРМАФРАНЧ ФИО 25-04-2012 Задача №000009999 <Конец>

+(29) ха, падрдон, это миста переносы делает лишние))

У них гендир где только не побывал. кажись это первая его собственная компания.

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

(32) MRG ?
)))))))))))))

по-моему излишне столько в комментах писать
я обычно пишу
//+Фамилия
//суть изменения

//-Фамилия

коротко и ясно

(33) что угодно, главное, чтобы в типовых этого не было. а всякие эти "Проект" и фамилии - хрен найдешь

(35) обычно этим и выступает название фирмы, реализующей проект

(36) обычно. если это достаточно уникальное словосочетание

(33) ага... потом понять в этой мешанине вообще ничего не возможно

(34) Я делаю так:

//!МойИдентификатор
<мой код>
//1c
//<код 1с, который я переписал>
//МойИдентификатор

Соответственно по строке //!МойИдентификатор всё прекрасно ищется потом :)

(11) что такого особенного?

как я делаю
// метка изменения, номер изменения.
// краткое описание
// закомментированный код типовой

мой код

//  метка конца изменения

Читаешь подобные темы и понимаешь - никто не умеет писать коменты к коду.
Все давно уже придумано.

(41) научи как правильно

(41) Да, научи нас, мастер Йода!))

(42)
Пишется в самой верхней части модуля
// (Версия №)  (Разработчик) (номер задачи, инициатор)
// (Описание)

При добавлении кода
// (Версия №) Начало
(код)
// (Версия №) Конец

Замена кода и правка по аналогии.

(43) сарказм?

(44) настоящий 1с-ник комменты не пишет вообще. :)

(44) я не очень поняла, вот идет обновление, окно сравнения модулей, предположим 5 разных правок. Вот я добралась до очередной правки, сравниваю код, там стоит Версия №, мне что б посмотреть, о чем это нужно вверх мотать? потом опять на правку, потом опять вверх?
зачем так скакать?

ну писец обзавидовались автору...уже и не знают чем еще укусить...

(0) С выходом на новое место работы и с наступающими праздниками!

(44) Сам придумал?

(44) ггг) очень сомнительно удобство такого комента)

(46) Именно, как вариант держать документацию под рукой, раз вам не знаком код.
Все что добавлялось, добавлялось не просто так. Как вы поймете что это недоработка, изменились требования или нечто иное?

Опять одинэсники спорят, какой сорт морковки слащще, пока нормальные проги хавают пирожные.

(49)+ (50) покритикуйте. В амбициях ваших я не сомневаюсь, сомневаюсь в другом.

(51) краткое описание каждого изменения,

(53) даты нет

(54) Тут ряд минусов - краткого описания может не хватить, доработка может иметь не одно вхождение в модуль и при накоплении истории по одному куску - код превратится в невообразимое нечто.

(56) тут тоже ряд минусов, нужно сочетать оба подхода

(55) согласен, поторопился.
// (Версия №) (Дата)  (Разработчик) (номер задачи, инициатор)

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

(57) Возможно минусы и есть ... в контексте обновления. Возможно минимальное описание упростило бы понимание доработки. Но на мой взгляд, читабельность кода пострадала бы. Зачем тащить лишнее?
Хотя безусловно в какие то куски стоит вставить пояснение минимальное.

(59) да ладно? Ничего никогда не распухало. Зато наглядно всегда и всегда под рукой.
Куда лучше чем куда то обращаться и где-то что-то искать ... теряется время и "свежесть" информации.

(53) Когда нужно связать несколько изменений кода одной задачей, то я добавляю ещё один идентификатор и всё. Когда необходимо, ещё и комментарии. Типа такого:

//!МойИдентификатор
//ИдентификаторИзменений. Мой комментарий.
<мой код>
//1c
//<код 1с, который я переписал>
//МойИдентификатор

(59) согласна, не нужно хранить версионирование в коде

(61) читабельность кода не страдает ИМХО

любопытно

// (Версия №)  (Разработчик) (номер задачи, инициатор)

// (Описание) не было этого присвоения, поэтому я и присвоил


При добавлении кода
// (Версия №) Начало

а=1;
// (Версия №) Конец

да комментов будет больше чем самого кода :))

(64) с версионированием будет вообще

// (Версия №1)  (Разработчик1) (номер задачи1, инициатор)
// (Описание) не было этого присвоения, поэтому я и присвоил
//  (версия №2) (Разработчик2) (номер задачи1, инициатор)
// (Описание) зря присвоил
//  (версия №3) (Разработчик1) (номер задачи1, инициатор)
// (Описание) нужно присвоить b


При добавлении кода
// (Версия №1) Начало
а=1;
// (Версия №1) Конец

// (Версия №2) Начало
// а=1;
// (Версия №2) Конец

// (Версия №3) Начало
b=1;
// (Версия №3) Конец

(63) и (65) версия - идентификатор изменения, без него код превратится в мешанину коментов.
В (65) не верно оформлена замена в коменте.

(64) Опять заявление из пустоты. Если у вас такое происходит, возможно проблема в другом?
Разумеется можно отказаться от такой схемы, проблем это только добавит.

(66) не верно оформлена замена в коменте. - да, сознаю.

(65) а когда версий будет больше чем 10 ? Пользуйтесь версионным контролем и не надо изобретать велосипед.

(68) 1С ники не любят читать всю дискуссию, они читают только последнее сообщение

(69) +100 :)

(69) Во-во. именно поэтому нефиг хранить в коде инфу КАК к этому дошли. Разбираться в самом г-коде итак трудно. Надо хранить актуальную инфу что делается. Закоментированный типовой вариант как исключение - область такая.

Что для франча - респект и уважуха, то нормальному специалисту обыденный порядок.