Как красиво и профессионально вести (оформлять) разработку в 1С
Разработка - Рефакторинг и качество кода
Краткая предыстория
В 2012 году мне досталась в наследство база с сильно измененной конфигурацией УТ 10.3. Эта база дорабатывалась в течении нескольких лет многими программистами (и штатными, и франчайзи). Документации практически никакой не велось, комментарии в коде были скудны и неинформативны, пользователи внедряющие тот или иной функционал уже давно уволились, спросить было не у кого... В некоторых случаях было совершенно непонятно что и для чего делалось и как это работает... И мы решили это прекратить. Были сделаны первые шаги, которые в дальнейшем привели к созданию небольшой системы оформления разработки. Данная система уже два с лишним года успешно функционирует в нашем холдинге и с лихвой окупает время потраченное на нее.
Из чего состоит эта система?
1. Комментарии в коде
2. Справочная информация
3. Цифровые обозначения отчетов/обработок
4. Добавление/изменение объектов
5. Контроль за исполнением
А теперь детально, по пунктам:
1. Комментарии в коде
О чём пойдёт речь. Комментарии в коде делают практически все программисты. Думаю всем понятно для чего они нужны. Комментарий - это признак произведенного изменения и описание этого изменения.
В чём проблема. Часто по комментарию можно понять только одно, то что было сделано изменение :) При этом искать описание этого изменения крайне проблематично (имеется ввиду описание доработки, техзадание), я думаю многие с этим сталкивались: кто-то его сделал и где-то сохранил... надо знать это место... потом умудриться найти нужную информацию... суметь увязать с тем что фактически есть в конфигурации... а может описание и не сохранилось... плюс исполнители часто забывают обновлять информацию об изменениях и она становится неактуальной. В итоге, все эти факторы мешают быстро понять кто, что, когда делал, и что нужно сделать сейчас (и в каком месте!)... А если посмотреть на проблему глобально, то выяснится что подобное ведение дел не позволяет быстро оценить отличия вашей конфигурации от типовой, какие контуры затронуты, насколько серьёзны эти изменения и т.д...
Как обычно решается. Смотрим код, пытаемся понять отличия от типовых механизмов, пытаемся понять зачем они сделаны, а если изменения сложны и непонятны - ищем у кого бы спросить (это обычно проще чем самому заниматься исследованиями!), либо сами разбираемся... В итоге на эти "разбирательства" уходит от нескольких часов до нескольких дней, и появляется очень большая вероятность совершить ошибку!
Наше решение. Сначала прошу сравнить комментарии трех программистов (примеры из рабочей базы):
Пример 1:
// voeк 30.20.2008 begin
//----------------------
// voeк 30.20.2008 end
Пример 2:
//AТ addon [14.04.2011]
//---------------------------------
//AТ addon [14.04.2011]
Пример 3 (наше решение):
//начало-ДГ.08.04.2014. Заказчик Пономаренков П. Запись реквизита ДД_Наименование_для_сайта_прайса.
//Нужно чтобы при любой записи элемента в этот реквизит записывалось полное наименование
//(если реквизит не заполнен).
//----------------------
//конец-ДГ
Проанализируем:
1. В первом примере видно:
- где начинается комментарий и где заканчивается
- кто сделал изменения
- когда сделаны изменения (правда ошибка в дате)
2. Во втором примере видно:
- кто сделал изменения
- когда сделаны изменения
3. В третьем примере (наше решение) видно:
- где начало комментария и где он заканчивается
- кто сделал изменения
- когда сделаны изменения
- кто заказчик
- название задачи
- описание задачи
Очевидно что третий пример содержит более информативный комментарий, который в полной мере выполняет свою функцию. И самое главное, для чего собственно это всё нужно, оформляя внесенные изменения подобным образом, вы сохраняете их в одном месте. В самом надежном и доступном. В базе данных. Не в файликах Word и Excel, не в сторонних программах типа Итилиума, не в головах пользователей и программистов, а ВМЕСТЕ с вашей базой данных... И даже по прошествию нескольких лет, можно легко извлечь все изменения, провести "инвентаризацию" системы и понять как сейчас она работает!
Как реализовать:
1. Все комментарии делаем однотипными и начинаем строго с символов "//начало-" (//начало-ДГ). Таким образом можно легко найти комментарии ВСЕХ программистов. Если нужно найти комментарии только ОДНОГО программиста - в поиске задаётся "//начало-ДГ". "ДГ" - это инициалы фамилии и имени программиста.
(Примечание: а теперь представьте ситуацию где один программист пишет "begin-end", другой пишет "начало-конец", а третий вообще рисует символы ">> <... будет очень сложно их найти.)
2. Указываем дату изменения (08.04.2014.) Иногда приходится доказывать пользователям что изменения начали работать с начала апреля, а не середины мая как они думают. Или нужно понять в какой последовательности изменения появлялись.
3. Указываем кто заказывал это изменение (Заказчик Пономаренков П.). По прошествии времени, очень часто забывается кто и зачем придумал это, указание заказчика поможет восстановить в памяти эту задачу. А если вы совсем забыли, или не участвовали в её реализации, можно получить дополнительную информацию непосредственно у заказчика :)
4. Даём краткое название задаче (Запись реквизита ДД_Наименование_для_сайта_прайса). Нужно для краткого указания того что делалось, какие были изменения (1) и для идентификации задачи (2). В этом примере, по краткому названию, видно что изменения касаются определенного реквизита (а не движений по регистру накопления например). А также краткое название позволяет найти ВСЕ места, где код менялся по этой задаче (используем копирование при вставке комментария).
5. Делаем подробное описание задачи (//Нужно чтобы при любой записи элемента, в этот реквизит... и далее). Нужно для понимания того, что и для чего делалось. Для каждого изменения делается свой комментарий (но первая строка у всех одинаковая!), если требуется сделать общее описание, то оно делается в одном месте. Например:
//начало-ОС.23.10.2014. Заказчик Смирнов О. Задача по написанию публикации.
//здесь описание №1
//конец-ОС
............
//начало-ОС.23.10.2014. Заказчик Смирнов О. Задача по написанию публикации.
//здесь описание №2
//конец-ОС
............
//начало-ОС.23.10.2014. Заказчик Смирнов О. Задача по написанию публикации.
//здесь описание №3
//и
//общее описание по всей задаче, потом программист поиском по названию задачи
//найдет это описание и прочтёт.
//конец-ОС
2. Справочная информация
О чём пойдёт речь. Польза от справочной информации думаю также для всех очевидна. Есть только две маленькие проблемы: обычно справка либо не информативна, либо ее попросту нет :) В нашей фирме, справочная информация делается всегда, подробно, и чаще всего ей пользуются... программисты :)
В чём проблема. У пользователей очень часто возникают вопросы типа: "откуда берет данные отчет", "как считает эта обработка", "что проверяется в документе" и т.д. А самое интересное то, что они уже не первый раз работают с этим отчетом/ обработкой/документом... они просто забыли... или сделали вид что забыли...
Как обычно решается. Что в таких случаях делает программист? Начинает вспоминать или лезет в конфигуратор... И хорошо если это делалось недавно, или алгоритм расчета какой-то простой... А если делалось давно, например несколько месяцев назад? Сколько времени надо потратить, чтобы полностью вспомнить реализованный функционал? Иногда до нескольких часов...
Наше решение. В каждом добавленном или измененном объекте есть нами добавленная справочная информация, и именно она позволяет быстро и красиво (прям на глазах у пользователя) ответить на все интересующие вопросы!
Как реализовать. В типовые объекты (справочники и документы) мы вставляем справку выше одинэсовской. Во внешних отчетах и обработках справка содержится как в самом объекте, так в специальном txt-файле (нужен для просмотра справки без конфигуратора). См. скриншоты:
Справка в программе

Справка внешней обработки

3. Цифровые обозначения отчетов/обработок
О чём пойдёт речь. Поговорим о удобстве работы с внешними отчетами и обработками.
В чём проблема. В один прекрасный день мы поняли что у нас в базе содержится огромное количество обработок и отчетов непонятно кем и для кого написанных, и главное, непонятно что они делают. И кроме этого, с ними крайне неудобно работать. Например: звонит пользователь и говорит что у него в отчете (далее следует какое-то название, что-то вроде с продажами) не появляются какие-то данные. Ваши действия: 1. найти отчет 2. вникнуть в то как он работает 3. понять что дальше делать (менять настройки, доработать его, ничего не трогать или что-то еще).
Как обычно решается. На первом же пункте возникает ступор, понять какой из отчетов "по продажам..." (вроде это слово прозвучало) использует пользователь, иногда очень проблематично, особенно в понедельник утром :) Вы начинаете его искать, попутно еще раз пять уточняя название, потому что оказывается что подобных отчетов несколько, а еще пользователь прочёл название отчета на форме, а в программе он называется немного по-другому... В итоге вы наконец находите нужный отчет и переходите к пункту 2.
Тут начинается самое интересное, хорошо если отчет типовой или написан вами, вы хоть будете знать что он делает, а если нет? Нужно как то быстро вникнуть в его суть, можно конечно спросить у пользователя, но пользователь вдруг оказался финансовым директором и ему некогда рассказывать вам об этом отчете, и скорее всего придется лезть в конфигуратор. Открыв отчет в конфигураторе вы вдруг понимаете что... ничего не понимаете... а комментариев в коде как правило немного. А иногда чтобы ответить на вопрос пользователя - нужно очень хорошо понять принцип работы отчета, а это значит досконально вникнуть в его содержимое. И тут многим (особенно начинающим программистам) приходит в голову достаточно простое решение - взять и переписать этот отчет. Но это не всегда возможно, а иногда просто невозможно (поэтому то и ценится умение читать чужой код)... В общем решение вопроса начинает затягиваться на неопределенный срок. А тут еще пользователь вас торопит. Наконец-то разобрались, но это еще не всё, нужно еще третий пункт отработать... А через месяц.... вам опять звонит этот пользователь и снова задает этот же вопрос, и вы снова проходите по этому кругу... Да-да, так к сожалению очень часто бывает.
Наше решение.
1. Чтобы быстро идентифицировать отчет (или обработку) мы присваиваем ему трехзначный цифровой код, где первая цифра закреплена за программистом, а две последующие - номер по порядку. А также присвается буквенное наименование показывающее назначение отчета. И когда пользователь говорит вам: "Посмотрите пожалуйста 516 отчет". Вы моментально находите его по цифре "516" и при этом знаете что под цифрой "5" у вас разработку ведет программист Иванов, к которому можно при случае обратиться за разъяснением.
2. Для понимания того как работает отчет, существует справочная информация, она записывается в сам отчет, а также в txt-файл. Файл этот нужен для просмотра справки без открытия отчета в 1С. В справке подробно описывается: принцип работы отчета (1), откуда берет данные (2), как их выводит (3), какие настройки нужно сделать (4), обязательные для заполнения поля (5), различные нюансы (6). В 90% случаев справочная информация позволяет дать ответ пользователю не прибегая к открытию отчета в конфигураторе.
Как реализовать:
1. Название (1), синоним (2), имя на форме (3), название каталога (4) и название txt-файла (5) всегда должны быть одинаковы. Например: DD_UT_741_Установка_доп_прав_у_пользователей. Где: DD – название компании, UT – название конфигурации, 741 – цифровой код отчета/обработки, «Установка_доп_прав_у_пользователей» - что делает данная обработка. Для удобства копирования слова разделены не пробелами, а нижними дефисами (всё название выделяется одним кликом мыши).
2. Цифровой код состоит из двух частей: 7 – цифра закрепленная за определенным программистом, 41 – номер обработки/отчета по порядку. 1С-вские обработки (измененные типовые) начинаются с «0», обработки неизвестных программистов – начинаются с «8».
3. В каждой обработке/отчете должна быть справочная информация, которая должна быть описана в txt-файле. Также создан специальный каталог для разработчиков где хранятся каталоги с отчетами/обработками. См. скриншот:
Каталог с внешними отчетами и обработками

4. Добавление/изменение объектов
1. При разработке стараемся по максимуму использовать типовой функционал, но при этом стараясь не менять его существенно, чтобы избежать ошибок и проблем с обновлением.
2. Все новые объекты (и реквизиты) добавляются с префиксом. Префикс всегда один и тот же и не привязан к программисту, нас это сокращенное название фирмы - "ДД_". Например: «ДД_Заявка_покупателя». Благодаря префиксу мы сразу понимаем какой функционал задействован, наш или типовой. Измененные и добавленные объекты добавляются в отдельную подсистему.
3. После изменения типовых объектов (или добавления новых), таких как справочники, документы – в них добавляется справочная информация с описанием произведенных изменений. Желательно вставлять их выше типовой справки, чтобы в первую очередь читались наши изменения.
5. Контроль за исполнением
Контроль осуществляется периодически, раз в два - три месяца. Для этого выборочно открываются объекты (документы, справочники, обработки), смотрится:
- справочная информация,
- названия отчетов/обработок в каталоге
- запускается глобальный поиск инициалов/ФИО программистов
Но лучший контроль - это конечно совесть исполнителя
поэтому желательно работать с людьми ответственными, за которыми не надо следить!
Ну и напоследок, вернемся к началу:
Нужно ли это руководителю IT... Что будет если уйдут программисты (или пользователи) "носители знаний"? Если возникнет разбирательство кто, зачем, когда внедрил функционал? Если нужно быстро провести ревизию конфигурации? Как быстро передать информацию другим специалистам?
Нужно ли это ведущему программисту... Что будет когда пользователи начнут задавать вопросы по тому функционалу который писал не он, а молодые специалисты или франчайзи? Сможет он быстро ответить на эти вопросы? А если это его доработки, то сможет ли он вспомнить то что делал полгода назад?
Нужно ли это программисту... Есть мнение что чем больше информации скрыто, тем больше ценность человека как специалиста. На деле же получается наоборот, чем больше человек скрывает информации, тем меньше с ним хотят работать, ведь быть зависимым никому не хочется, а при случае - постараются избавиться от этой зависимости. Да и профессионализм этого специалиста явно под вопросом.
Нужно ли это пользователю... Как свести к минимуму количество обращений к программистам если у пользователя элементарно нет справочной информации? Как ему максимально быстро получить ответ на свой вопрос если программисту надо много времени на то чтобы найти его?
Мы для себя давно ответили на эти вопросы. Теперь ваша очередь по новой взглянуть на них :)
Всего вам доброго!
Вступайте в нашу телеграмм-группу Инфостарт
Вы можете заказать платную адаптацию этой статьи под ваши задачи на «Бирже заказов».
- 0% комиссии — оплата напрямую исполнителю;
- Исполнители любого масштаба — от отдельных специалистов до команд под проект;
- Прямой обмен контактами между заказчиком и исполнителем;
- Безопасная сделка — при необходимости;
- Рейтинги, кейсы и прозрачная система откликов.
См. также
Нейросети Рефакторинг и качество кода Запросы Разработчик 1С 8.3 Абонемент ($m)
Нейросеть написала запрос или процедуру для вашей базы 1С, и непонятно, все ли имена в нём настоящие. Обработка компилирует текст без выполнения, сверяет его с метаданными этой базы и к каждой ошибке пишет настоящее имя, например ВНаличииОстаток вместо выдуманного КоличествоОстаток. Список ошибок с подсказками одной кнопкой копируется обратно в чат с моделью.
10 стартмани
02.11.2026 442 2 nedomolkov.ivan 3
Рефакторинг и качество кода Разработчик 1С:Предприятие 8 Россия Бесплатно (free)
Одна проверка в обработчике кнопки может выглядеть достаточной, пока ту же операцию не вызовут из другого места. На примере управляемой формы разберём, почему так происходит, как разместить проверку в общей серверной функции и чем отличается удобная проверка ввода от обязательного условия выполнения операции.
29.10.2026 458 YA_777378709 0
Рефакторинг и качество кода Разработчик Бесплатно (free)
Рассказываем, почему качественный код – это не техническая прихоть, а актив, который помогает бизнесу быстрее адаптироваться к изменениям и запускать новые фичи без бесконечного преодоления техдолга. Показываем, как объяснить бизнесу ценность рефакторинга через понятные признаки: замедление разработки, неточные оценки, страх перед legacy и хрупкость системы. Разбираем, почему неправильный рефакторинг может быть дороже его отсутствия, какие анти-паттерны ломают процесс и как не превратить улучшения в бесконечную переделку ради переделки. Объясняем, как сделать рефакторинг частью культуры команды: договориться с бизнесом, научить разработчиков видеть проблемные места, закрепить правила и поддерживать улучшения на уровне тимлидов, архитекторов и всей команды.
28.10.2026 565 Pavel791 0
Рефакторинг и качество кода HighLoad оптимизация Системный администратор Разработчик Стажер 1С 8.3 Абонемент ($m)
Если к HTTP-сервису 1С обращаются сразу несколько программ, сколько запросов в секунду он успеет обработать? Я опубликовала простой HTTP-сервис на нашей "подопытной" конфигурации «Нано-УТ» (файловая база, Apache, без прав администратора) и нагрузила его скриптом на Python. Ответ: около 15-16 запросов в секунду, сколько бы клиентов ни обращалось одновременно. Запросы ждут своей очереди, и при 32 клиентах ответ приходит через 2 секунды вместо 64 мс. Заодно разобрала скрипт из первого варианта статьи: он «проверял» сервер, который отвечал по одному, и считал ошибки вместе с успешными ответами. В архиве исправленный скрипт, учебный сервер, HTTP-сервис для 1С и инструкция по запуску.
1 стартмани
23.10.2026 579 Ninel_S 3
Рефакторинг и качество кода Разработчик 1С 8.3 Абонемент ($m)
Запустили Analyzer 1C 2.7.65 на промышленной конфигурации (596 модулей, 13 669 функций) и исследовали перегруженные функции (до 1887 строк), циклические зависимости и экран «Циклы» (кольцо из 64 модулей). Разобрали, почему популярные метрики (McCabe, связность) не представлены в продукте вендора, и составили пошаговый план разделения модуля. Привели проверенный платформой 8.3.27 пример до и после рефакторинга и выявили скрытую ловушку загрузки модулей с точкой в имени.
9 стартмани
19.10.2026 517 Ninel_S 2
Рефакторинг и качество кода EDT СКД Разработчик 1С 8.3 1С 8.5 1С:Бухгалтерия 3.0 Бесплатно (free)
Одиннадцать граблей схем компоновки, которые не видно в конструкторе и не ловит EDT, на реальных отчетах БП КОРП. Формат числа задается в двух местах, и условное оформление варианта перебивает формат поля. Ресурс складывает штуки с часами, и помогает выражение «только когда единица одна». Ресурс пуст в детальных записях, параметр не появляется в шапке без userSettingID, valueListAllowed ломает границы периода, Остатки и СрезПоследних с параметром периода падают с «Несоответствием типов», title без xsi:type дает «Исключение XDTO» при загрузке. В конце код проверки схемы из файла до обновления базы, сводная таблица и чеклист.
16.10.2026 627 Konstmax13 2
Инструментарий разработчика Нейросети Рефакторинг и качество кода EDT Разработчик 1С 8.3 1С 8.5 1С:Бухгалтерия 3.0 Бесплатно (free)
Как ИИ-агент (Claude Code) работает в живом EDT-проекте 1С:Бухгалтерии КОРП 3.0: из чего собрать стенд с MCP-сервером для EDT, как ставить задачи агенту, где он ломает проект и какие проверки это ловят. Реальные случаи: рукописные метаданные, ронявшие конфигуратор; четыре дня зависшего обновления из-за порядка блоков в Rights.rights; ошибки, которые EDT пропускает, а платформа нет; сплошная сверка вместо «вроде работает». В приложении шаблон CLAUDE.md, шаблон правила, чеклист перед обновлением базы и скрипты проверки ролей и схем СКД.
15.10.2026 3744 Konstmax13 11
Рефакторинг и качество кода Тестирование QA Разработчик 1С 8.3 Абонемент ($m)
Инженерный анализ влияния (Impact Analysis) при изменении общего метода в 1С:Предприятии: почему штатный поиск ссылок скрывает 99% зависимостей и как обратный обход графа вызовов выявляет 370 скрытых потребителей на глубине 3 уровней. В статье — верификация сквозной цепочки обмена с маркетплейсом; в архиве-компаньоне — автономный BFS-анализатор на Python, слепки графа и план регрессионного тестирования.
1 стартмани
12.10.2026 380 Ninel_S 0
2. Заказчики в справке - это тоже умиляет. Если их хотя бы больше 10, то это уже будет проблемой.
3. Номера отчетов - идея нормальная.
4. Префиксы у объектов - идея нормальная.
5. Контроль за исполнением - это хорошо. Именно из-за низкой исполнительской дисциплины или из-за отсутствия контроля за исполнением все предыдущие пункты и не будут работать. Или будут.
Даты доработок очень нужная информация даже по прошествии n-лет. Например сталкивался с доработками в типовой сделанными в 12 году. В 13 году 1С доработала функционал и необходимость в "дописках" пропала. Именно по дате доработки и определили что функционал больше не нужен.
Это когда есть такая система учета задач! тут не на каждом предприятие есть элементарно список доработок в word формате... не говоря уже о системе учёта задач.
Ещё варианты предложить? Например я звонил Пупкиным и просил прокоментировать некоторые сделанные ими доработки. Люди были вполне адекватными и рассказывали что, как и для чего было сделано.
по части дат и фамилий: отчасти соглашусь, по прошествию времени многое становится не нужным, но в текущем времени - это ооооочень хорошо работает. А даты и со временем востребованы, когда "чистили" бухгалтерию от изменений по датам понимали оставлять изменения или нет.
заказчики в справке: это тоже для текущей работы.
по контролю: полностью согласен, поэтому на работу берём людей которых можно "выпустить в самостоятельное плавание", у нас 95% работы на доверии основано (среди программеров).
тут дело не в деньгах, а в отношении. Видимо франчам просто не ставилась задача писать документацию. А вот сейчас у нас любой разговор начинается с вопроса будет ли на выходе документация оформленная нужным образом.
Заказчик в бумагах один фиг ничего не понимает в большинстве случаев и тратить денег на них по умолчанию не хочет. Это, кстати, одна из причин начала работ не в крупной франче, а по мельче. В мелких на бумагах не настаивают, а в крупных это типа стандарт, который естественно увеличивает число часов к оплате.
Потом на мой взгляд происходит одно из событий, влекущее передачу дел полностью или частично. Причины видел следующие:
1. рост заказчика, что повлекло появление штатного сотрудника
2. смена руководства заказчика, который не понимает зачем "это было нахреноверчено" (не факт, что "нахреноверчено" было плохо, просто не понятно)
3. смена франча (причин много, от отказа оплаты из-за кризиса, а потом уже назад вернуться стремно, толи франч накосячил как, толи у франча "любимый" специалист уволился, а остальные балбесы...)
Но самостоятельного осознания заказчиком я не встречал. Чтобы вот так позвонил мне клиент со словами:
"Антон, мы тут с тобой наделали делов, а вдруг меня уволят или тебя, давай все задокументируем, я с директором договорился, он все оплатит" - звучит как сказка
"Имярек, мы тут с тобой наделали делов, а вдруг меня уволят или тебя, давай все задокументируем, я с директором договорился, он все оплатит" - звучит как сказка
- было, неделю назад, именно такими словами
В нем как минимум видно, кто из разработчиков в последний раз правил тот или иной отчет.
А если еще и административно затребовать от всех писать комментарии к коммитам (при сдаче в хранилище), то, возможно, и комментарии в коде не нужны.
да, о хранилище не упомянул, хотя оно у нас конечно есть и работа идет через него. В него вносится информация, но в минимальном виде, только о затронутых объектах. Практика показывает, что когда идет разбор кода - смотреть куда-то кроме текущей конфы крайне неудобно.
Можно быстро найти глобальным поиском во всей конфигурации все модули в которые вносились изменения в рамках одной задачи. Экономит время.
От себя добавлю, внешние обработки лучше сохранять в хранилище =).
В типовых конфигурациях есть справочник "ВнешниеОбработки" туда и заливайте всё ("сохраняются" в хранилище значений и "восстанавливаются" при запуске).
Это снимет проблему с поиском где, что и т.д. Ну и плюс в бекапе базы будут все обработки.
не дорастем. У нас два критерия: 1. простота 2. эффективность. На первом же пункте мы и остановимся :) возможно для крупных предприятий это нужно, классно, удобно и т.д. Для нас - нет. И задачи у нас другие стоят. Нам нужно понимание того что сделано, а не оптимизация кода (а именно это я увидел в статье по вашей ссылке).
Считаю что указания "кто внес внес изменения и когда" не нужны в коде. Комментарий "что и зачем" к коду бесспорно нужен. Квалифицированный разработчик должен понять по коду и этим комментариям зачем данный код, и нет необходимости привязывать изменения к конкретному разработчику. Дата так же не особо информативна - когда внесены изменения она конечно покажет, но когда эти изменения пришли в продуктивную конфигурацию заказчика врятли. Как правило, учет всех задач/трудозатрат/изменений ведется в какой то еще системе, где и нужно отслеживать кто, зачем, когда и что делал.
//Дата, Сотрудник, Ссылка на ТЗ или на заявку/инцидент с системе регистрации и учета заявок/инцидентов
когда версий у объекта 100, тяжеловато будет найти сравнением поочередно каждой.
я всё так останусь при своем мнении, что при групповой разработке имя автора полезно указывать в комментариях
Но так же я на своем опыте знаю, что спрашивать разработчика о коде который он написал более пары недель назад на 80% бесполезно - он не помнит зачем вносил изменения.
Разработчик может помнить, что и как в коде, если он один занимается постоянно каким-то небольшим ограниченным количеством объектов/подсистемой. Тут наверно подход позвонить разработчику будет актуальным. Но опять же, если и так известно что этот разработчик занимается этим объектом/подсистемой то зачем комментарий с именем в коде...
У Вас часто получается позвонить указанному в комментариях разработчику, и что бы он сразу вам рассказал зачем этот кусок кода?
Понятно что со временем эти комментарии теряют свой смысл и их можно просто убирать.
//{ Сидоров 2014-07-01 удалено
////{ Петров 2013-05-30 Изменено
//////{ Иванов 2011-05-30 добавлено
////...
///Заменен на:
//...
//////}
////}
//} ПоказатьДумаете читабельно?
полностью согласен с вами насчет этого: "спрашивать разработчика о коде который он написал более пары недель назад на 80% бесполезно". ИМЕННО для таких случаев нами сделаны подробные комментарии. По ним то как раз и удается понять что/для чего было сделано!
Что касается ФИО и стандартов: да, возможно стандартами это не предусмотрено, НО, у нас есть производственная необходимость и значит мы имеем полное моральное право это применять. К тому же ничего крамольного в этом нет.
И не смотрите пожалуйста на стандарты как на догму, это всего лишь унификация :)
Теперь по сути:
1. Комментарии в коде конечно важны, только они должны плавно перетекать в комментарии к коммитам, а код стремится к самодокументируемости.
2. Справка или документация важна для пользователя, разработчику надо заглядывать в ТЗ.
3. Страх и ужас! Такая система говорит о прежде всего неумении организовать и каталогизировать собственное рабочее пространство. откройте для себя git
4. Страх и ужас №2! Используйте подсистемы и только их. 1С - скорее вводи расширения!!!
5. Почитайте что такое коде-ревью, какие есть практики и ваш ежемесячный контроль отпадет сам собой.
вы мне напоминаете выпускника ВУЗа, без обид :), всё правильно говорите, прям как по учебнику, не поспоришь. НО, это не работает :)
по п.2: справка - это то что находится "под рукой", а попробуйте в условиях отсутствия времени и крайней нервозности пользователей (а в таких условиях работают многие 1с-программисты) - найти ТЗ и ответить на все их вопросы. Думаю у вас это не получится.
по п.3: зачем нам git? чтобы быть модными? наша задача простая: 1. хранить отдельно (диск бэкапируется, ничего не пропадет, всё доступно, описание открывается обычными блокнотами) 2. пронумеровать. Ни для для первого пункта, не для второго нет смысла заводить модную программу.
по п. 4: пункт 2 вы читали? или что-то другое имелось ввиду?
по п. 5: круто! но это немного другая тема, более обширная, и нужная опять таки для крупных предприятий с большим штатом программистов.
И, в принципе, придумал себе ТС набор действий для заполнения пустот во времени - порадуемся за него. А использовать или нет у себя - тут каждый для себя решает.
1. Использую, часто. :D Так что будет: "если использую часто"? Не увидел ветки.
2. Не он придумал. Он только статью написал. Это все и до него было...
3. Когда заказчик начитавшись таких статей требует, то "каждый решает для себя", не актуально.
Напомнило анекдот:
3 Часа ночи. Звонок в службу поддержки (5 летней девочки).
- Доброй ночи.
- Дяденька, а вы не подскажите как настроить интернет?
- А взрослые рядом есть?
- Есть, но они пьяные.
- Нажимаем кнопку "Пуск"...
- Дяденька, дяденька. Вы не поняли. У меня FreeBSD...
у нас есть такие решения, что мне порой сложно глядя в собственный код понять зачем я это сделал... быстро понять... понятно дело что я всё вспомню, но это время, которого иногда нет... поэтому пока всё же склоняюсь к пояснениям в коде...
Это как в автомобиле: я знаю как поменять ремень кондиционера, я знаю где его купить и сколько он стоит, я знаю когда менять его, но я могу забыть что для его замены нужно двигатель домкратить. Небольшой такой нюанс :) Поэтому я хочу в комментах сразу видеть "нужен ли мне домкрат".
насчет 1С согласен полностью, это они "умеют".
2.Вносить в справочную информацию какие-то технические комментарии вообще неуважение к пользователям. Тут одно из двух либо вы не приучаете пользователей пользоваться справкой, либо вы их попросту не уважаете. Никому не совету пользоваться данным советом.
Справка должна быть актуальной и понятной для пользователя.
3, 4. Эти советы вообще противоречат стандартам разработки - не советую так делать, куча разных префиксов только внесет бардак в дерево конфигурации и будет очень проблематично что-либо в нем искать. Если нужно сохранять информацию о том, кто добавил данный объект можно воспользоваться полем "Комментарий" - он есть у каждого объекта и виден только в конфигураторе.
1. Объемные > непонятные :)
2. Кто сказал что в справке техническая информация? Там нет жутких малопонятных терминов. И есть два нюанса: 1. пользователь либо умеет читать справку, либо нет 2. Писать нужно как для себя, и стараться муть не разводить. Кстати, многие ссылаются на стандарты 1С, так вот думаю по части справки им до нас - как хромому до Пекина пешком)) уж простите за прямоту!
3. Вы невнимательно прочитали, нас нет кучи разных префиксов, цитирую: "Префикс всегда один и тот же".
2. Оформляю код локанично:
для большого куска кода
Процедура ПриИзмененииТЧТовары()
...
//Мое!!! Начало Дима 25.12.2014 v13
//Проверяем максимальное ограничения скидки
Если НЕ СтрокаТовары.Номенклатура.Пустая() Тогда
...
КонецЕсли;
//Мое конец Дима
Показатьдля малого куска кода
Объект.Ответственный = ?(...); //Мое!!! Дима 25.12.14 БЫЛО: Объект.Ответственный = ...;
И само-сабой описание функций и процедур
//Мое!!! Дима 25.12.14 Вся функция
//Описание: Выискивает в строке "СтрокаДляПоиска" вырезку ограниченную символом "СимволРазрыва"
// с порядковым номером "ПорядкНомерОтрезка"
//Возвращает Найденную символьную вырезку, или "" если не нашла по любой причине.
Функция ПолучитьСтрокуМеждуСимволами(СтрокаДляПоиска, ПорядковыйНомерОтрезка, Разделитель=",")
...
КонецФункции //ПолучитьСтрокуМеждуСимволами(СтрокаДляПоиска, ПорядковыйНомерОтрезка, Разделитель=",")
Показать3. Коментарии при записи в хранилище также незабываю.
P.S. Тема оформления периодически всплывает на инфостарте, и дискутировать по ней можно долго. Интересно было прочитать почему кто-то использует именно этот инструмент (методику), и какие получает от этого преимущества. (т.е. чисто практика, никакой воды). Отдельное спасибо за ссылки на первоисточники и т.п., считаю это хорошим тоном.
- начало/конец
- кто/когда
- код доработки, например, "д001" (об этом ниже)
2. Более информативно, с моей точки зрения, делать подсистемы.
Например, есть общая подсистема "Префикс_ВнесенныеИзменения".
А "в ней", есть подчиненные подсистемы вида "д001_АвтоформированиеДокумента", где
"д" - это значит доработки (еще есть "и" - изменение типового функционала)
"001" - порядковый номер.
"АвтоформированиеДокумента" - краткое описание доработки.
Далее в составе этой подсистемы указываются объекты, которые менялись/добавлялись, а в справочной информации более детально описывается задача.
В итоге, всегда можно быстро вывести элементы, которые были изменены по каждой доработке и при необходимости прочитать что за изменение и зачем оно нужно
Из "минусов": данный подход не работает с версиями 8.1 и ниже, где не было понятия "Подсистемы".
Кстати пример 3 -коммент не нужен. В принципе. Там из кода все должно быть понятно.
Веду версионный учёт конфигураций. Уже много раз помогало =). Просто перед внесением в конфу правок сохраняю пекущую конфигураци. Нуменрую конфигурации. А в коментировании изменений держим приоритет на объяснение изменения, а не сохранении истории изменений. История в архиве конфигураций хранится =).
Где-то так.
Единственный плюс статьи - показать важность момента, тем кто до этого еще пока не дошел. Ну и если уж про опыт, то предлагаю размяться от обратного:
1. куча франчей и фикси меняется в конфе за несколько лет. В итоге получаем "специалистов", которым надо объяснять про каменты в коде....
Заказчику стоит пересмотреть кадровую политику. ГБ и и дир тоже меняется несколько раз в год? Может они тоже для себя систему тайных записей придумают?
Хотя рыба гниет с головы, возможно на первом пункте лучше все и закончить. Пристрелить эту старую лошадь, чтобы не мучалась.
2. Справочная информация.
судя по рассказанному справочная система отсутствует. Набор лоскутных текстовых файликов... это лучше чем ноль, но меньше чем необходимо. Справка должна быть полная, внятная, со скриншотами, взаимосвязями. Иначе техподдержка будет требоваться постоянно (покрасневший телефон). Даже на базе типовой конфы должна быть справочная система, которая описывает все изменения. Организовать ее можно кучей способов, например:
- встроить в конфу свой справочник, который содержит описания, организовать удобный вывод пользователю
- Внутренний сайт базы знаний, из конфы кнопка которая открывает ссылку. Простейший вариант - на сервере 1С ставим appserv + wordpress. Сайт можно поделить разделами под каждую БД 1С
- на сетевом диске положить файл (word\pdf\html\*..), открывать кнопкой из конфы.
Например добавленный отчет (все равно внешний он или внутренний) должен быть описан примерно так:
Название отчета (в шапке, форме, файле, справке - единое, тогда не нужны коды, шифры, и пр. пляшущие человечки)
Функционал (кратко, больше одного предложения, на пару абзацев) - что показывает, какие могут быть варианты, чем отличается от похожих (ссылки)
Скриншот - (чтобы не было половины вызовов чтобы просто посмотреть на его форму, вид)
3. Техподдержка.
Если по обращению пользователя можно переписать отчет полностью, значит нет у вас ТПД. Есть программеры, которых заставляют работать на ТПД. Песня про бегуна на короткие дистанции, которого заставили бежать на длинные.... а он не хотел. © Высоцкий
Если нет 1 и 2, то 3 могло бы решить проблему. 1,2,3 это три черепахи на которых стоит ИТ система. Хватит штукатурить здание в котором нет фундамента.
Я благодарю вас за то, что приняли участие в обсуждении этого вопроса! Ваше мнение, даже если оно кардинально отличалось от моего, было мне очень интересно.
Да, эта система не идеальна. Да, есть вещи более профессиональные. Да, что-то в ней можно и нужно пересмотреть... НО, это всего лишь набор приемов, главное же в этой статье - привлечь ваше внимание к этой проблеме. Проблеме которую можно охарактеризовать фразой: "после нас - хоть трава не расти".
Прошу вас, думайте о своем завтрашнем дне, о комфорте в работе, о вашей эффективности, о вашем развитии, и наконец о людях которые придут вам на смену! Вот что главное в этой статье!
Комментарий нужен не для фиксации факта правки - для этого есть системы контроля версий. Комментариями описывается то, что не является очевидным при прочтении кода посторонним человеком.
Плюс вы свои разработки в конфе найдете обычным способом гораздо быстрее, и откатываться на другие версии врятли будете, 1С не та система где это прокатывает, проще закомментировать код прям на месте изменения и потом при случае посмотреть в чем отличие вашей версии от той что была, нежели откатываться на прошлую и прочие умные штуки делать. И это с учетом того что с базой работают несколько программистов.
P.S. Просто закомментить старый код - сколько нервов я потратил скролля тысячи строк закоменнтированного кода в попытке найти код действующий. Горите в аду!
прошло семь лет, я описал в (99) что изменилось за это время. А если в двух словах то: все что тут описано это по сути тактические приемы, при глобальной разработке конечно требуются хранилище и прочее. Но вот что интересно, в наших базах порядка и понятности больше (в разы больше), чем в тех что я видел на хранилищах.
Про сообщение предыдущее. Ну вы опять лукавите. Если какая-то логика обработки данных хранится у вас в коде и требует сохранения всей истории кода в виде закомментированного кода для её понимания, то "bus factor" висит над вами дамокловым мечом.
По своим подходам, как понятно, не раскаиваюсь. Мнение не поменялось, скорее наоборот укрепилось. Иллюстраций с тех пор насмотрелся в разы больше.
1. Комментарии в коде (единственное внятное средство вспомнить кто и зачем всё это сделал когда уже все забыли).
2. Справочная информация (сейчас перешла на подсказки полей и отдельные закладки на форме, так ближе к пользователю).
3. Цифровые обозначения отчетов/обработок (имба до сих пор, говоришь цифру и всем все понятно).
4. Добавление/изменение объектов (тоже рабочая тема, префикс стал короче, но всегда используется, сразу понимаешь чей объект).
5. Контроль за исполнением (контроль сейчас не выполняется, будущее наступило).
------------------------------------
А теперь про штатные средства:
- EDT для богов
- хранилище используется когда людей много и совсем друг друга не знают
- Git это чтобы себя успокоить, как правило ни у кого времени на него нет.
------------------------------------
И вот что получается: наши так называемые "поделки" до сих пор успешно применяются и все также выручают, пока чьи-то космические корабли все еще бороздят просторы мирового океана, а люди тем временем спорят и умничают о их применении.
добавлю, что я освоил видеоинструкции - для любой задачи создаю видеоролики с комментариями - никакой документации уже не требуется - только запись с экрана с озвучкой за кадром - все понятно сразу - зачем создавалось, куда нажать, как работать.
пока проблема одна - копится много видеофайлов (5 мин ролик = 50 Мб)
Вы можете заказать платную консультацию или разработку у автора. Будет создан приватный заказ на «Бирже заказов» для автора.
№ 292511
Создание 19.12.14 10:37
Обновление 19.12.14 10:37
Просмотры 33478
Загрузки 0
Рейтинг
113
Комментарии 102
Код открыт Не указано
Рубрики Рефакторинг и качество кода
Кому Разработчик
Тип файла Нет файла
Платформа Не имеет значения
Конфигурация Универсальные
Операционная система Windows
Страна Не имеет значения
Отрасль Не имеет значения
Налоги Не имеет значения
Вид учета Не имеет значения
Доступ к файлу Бесплатно (free)