При работе с платформой 1С:Предприятие 8.3 разработчики часто сталкиваются с задачами, требующими формирования печатных форм с использованием объекта ТабличныйДокумент. Одной из распространенных задач является вывод данных построчно с контролем количества строк на странице и автоматическим добавлением разрывов страниц. В процессе написания кода могут возникать ситуации, когда два, на первый взгляд, схожих метода ведут себя по-разному в зависимости от контекста, но при этом код остается синтаксически корректным. Рассмотрим подробнее такую ситуацию с методами Присоединить и Вывести, а также выясним, как существующие инструменты проверки кода помогают или не помогают выявлять подобные нюансы.
Изначально перед нами стоит задача найти инструмент проверки кода, который выявит ошибку в коде, представленном ниже. Проблема заключается в том, что в данном коде используется метод Присоединить вместо Вывести для построчного вывода в табличный документ. Технически код работает, но он не соответствует стандартным практикам и может привести к непредсказуемому поведению в более сложных сценариях. Давайте проанализируем этот код:
&НаСервере
Функция СформироватьОтчетНаСервере()
ТабДок = Новый ТабличныйДокумент;
Макет = РеквизитФормыВЗначение("Объект").ПолучитьМакет("МакетПечати");
// --- Данные для демонстрации (имитация вашего списка физлиц) ---
ИсходныеДанные = Новый Массив;
ИсходныеДанные.Добавить("Иванов Иван Иванович");
ИсходныеДанные.Добавить("Петров Петр Петрович");
ИсходныеДанные.Добавить("Сидоров Сидор Сидорович");
ИсходныеДанные.Добавить("Александров Александр Александрович");
ИсходныеДанные.Добавить("Михайлов Михаил Михайлович");
ИсходныеДанные.Добавить("Сергеев Сергей Сергеевич");
ИсходныеДанные.Добавить("Дмитриев Дмитрий Дмитриевич");
ИсходныеДанные.Добавить("Орлов Орел Орлович"); // 8-й
ИсходныеДанные.Добавить("Соколов Сокол Соколович"); // 9-й, должен пойти на новую страницу
ИсходныеДанные.Добавить("Волков Волк Волкович");
ИсходныеДанные.Добавить("Зайцев Заяц Зайцевич");
ИсходныеДанные.Добавить("Медведев Медведь Медведевич");
ИсходныеДанные.Добавить("Лисицын Лис Лисович");
ИсходныеДанные.Добавить("Ежов Еж Ежович");
ИсходныеДанные.Добавить("Бобров Бобр Бобрович");
ИсходныеДанные.Добавить("Федоров Федор Федорович"); // 16-й
ИсходныеДанные.Добавить("Николаев Николай Николаевич"); // 17-й
ИсходныеДанные.Добавить("Владимиров Владимир Владимирович");
ИсходныеДанные.Добавить("Павлов Павел Павлович");
ИсходныеДанные.Добавить("Романов Роман Романович"); // 20-й
// --- Конец данных для демонстрации ---
// Счетчик строк на текущей странице.
СчетчикФИОНаСтранице = 0;
// Лимит строк, который нельзя превышать.
ЛимитСтрокНаСтранице = 8;
// --- Основной цикл обработки данных ---
Для каждого ФИО Из ИсходныеДанные Цикл
ОбластьСтроки = Макет.ПолучитьОбласть("СтрокаФИО");
ОбластьСтроки.Параметры.ФИОМОЛ1 = ФИО;
ПроверяемыйМассивОбластей = Новый Массив;
ПроверяемыйМассивОбластей.Добавить(ОбластьСтроки);
Если ТабДок.ПроверитьВывод(ПроверяемыйМассивОбластей) И СчетчикФИОНаСтранице < ЛимитСтрокНаСтранице Тогда
ТабДок.Присоединить(ОбластьСтроки);
СчетчикФИОНаСтранице = СчетчикФИОНаСтранице + 1;
Иначе
ТабДок.ВывестиГоризонтальныйРазделительСтраниц;
ТабДок.Присоединить(ОбластьСтроки);
СчетчикФИОНаСтранице = 1;
КонецЕсли;
КонецЦикла;
Возврат ТабДок;
КонецФункции
Автор кода уже попробовал следующие инструменты, но они не выявили описанную ошибку:
Давайте разберем, почему такая "ошибка" является сложной для автоматического обнаружения и как мы можем подойти к ее решению.
Проблема заключается в том, что в приведенном коде используется метод ТабДок.Присоединить(ОбластьСтроки), тогда как для вывода строк в табличный документ по идее предназначен метод ТабДок.Вывести(ОбластьСтроки). На практике в данном конкретном сценарии эти два метода могут работать одинаково, что создает иллюзию корректности кода. Разберем принципиальное различие:
ТабДок.Вывести(Область): Этот метод предназначен для вывода табличного документа (или его области) в результирующий табличный документ, добавляя его со следующей строки вслед за самой нижней выведенной строкой. То есть, он всегда добавляет содержимое вниз. Это основной метод для построчного или блочного формирования отчетов, где новые данные должны располагаться под предыдущими.ТабДок.Присоединить(Область): Этот метод предназначен для присоединения табличного документа (или его области) к результирующему табличному документу, помещая его в следующей колонке правее самой правой выведенной колонки. Изначально он задуман для горизонтального расположения областей, то есть для формирования колонок.Почему же в коде автора Присоединить работает как Вывести?
Если ранее не было вызовов метода Вывести или Присоединить, то Присоединить начнет вывод с первой строки, подобно Вывести. Если же после вывода одной строки (которая занимает всю ширину текущей области) вы попытаетесь "присоединить" следующую, то справа места уже нет. В такой ситуации платформа вынужденно выводит новую область снизу, имитируя поведение Вывести. Таким образом, в простых сценариях построчного вывода, когда каждая выводимая область занимает всю доступную ширину, результат работы этих двух методов может оказаться идентичным.
Однако, это не означает, что они взаимозаменяемы. Если мы попытаемся присоединить прямоугольную область или использовать именованные ячейки, где контекст "справа" имеет значение, то разница станет очевидной, и код с Присоединить поведет себя не так, как ожидалось для построчного вывода. Это и есть классический пример семантической ошибки: код синтаксически корректен, он выполняется, но его логика не соответствует намерению разработчика или официальной документации, что может привести к проблемам при изменении условий или в более сложных кейсах.
Стандартные инструменты статического анализа кода, такие как 1С:Enterprise Development Tools (EDT), SonarQube, 1С: Автоматизированная проверка конфигурации (АПК) и BSL Language Server, ориентированы преимущественно на следующие типы проверок:
Проблема с Присоединить и Вывести относится к более тонкому слою — семантическому анализу. Для выявления такой ошибки инструменту необходимо "понять" намерение разработчика (что он хочет вывести строки, а не колонки) и затем сопоставить это намерение с фактическим поведением методов и контекстом их использования (например, типом выводимой области, ее размерами, наличием предыдущих вызовов). Современные статические анализаторы для 1С пока не обладают такой глубокой способностью к интерпретации контекста и намерений.
Это не является недостатком инструментов, а скорее отражает сложность автоматического семантического анализа. Автоматическая проверка правильности алгоритмов и оптимизации методов часто невозможна, потому что только разработчик знает цели и контекст своей задачи. Сюрприз заключается в том, что такие инструменты, как правило, не проверяют правильность самого алгоритма, а фокусируются на его "здоровье" с точки зрения синтаксиса и общепринятых плохих практик.
Поскольку "идеальный" автоматический инструмент для выявления подобных семантических нюансов пока недоступен, мы можем рассмотреть несколько подходов:
Это самый надежный, но и самый трудоемкий метод. Опытный разработчик в процессе код-ревью может заметить такие тонкости и объяснить junior-разработчику правильное использование методов. Это требует инвестиций в обучение и менторство. Важно не только указывать на ошибку, но и объяснять ее причину и потенциальные последствия.
Прежде всего, давайте приведем исходный код к корректному виду, используя метод Вывести. Это не только сделает его соответствующим документации, но и более предсказуемым в поведении. Отметим, что логика разбиения на страницы также может быть упрощена для лучшей читаемости.
Давайте посмотрим на исправленный вариант кода:
&НаСервере
Функция СформироватьОтчетНаСервере()
ТабДок = Новый ТабличныйДокумент;
Макет = РеквизитФормыВЗначение("Объект").ПолучитьМакет("МакетПечати");
// --- Данные для демонстрации (имитация вашего списка физлиц) ---
ИсходныеДанные = Новый Массив;
ИсходныеДанные.Добавить("Иванов Иван Иванович");
ИсходныеДанные.Добавить("Петров Петр Петрович");
ИсходныеДанные.Добавить("Сидоров Сидор Сидорович");
ИсходныеДанные.Добавить("Александров Александр Александрович");
ИсходныеДанные.Добавить("Михайлов Михаил Михайлович");
ИсходныеДанные.Добавить("Сергеев Сергей Сергеевич");
ИсходныеДанные.Добавить("Дмитриев Дмитрий Дмитриевич");
ИсходныеДанные.Добавить("Орлов Орел Орлович"); // 8-й
ИсходныеДанные.Добавить("Соколов Сокол Соколович"); // 9-й, должен пойти на новую страницу
ИсходныеДанные.Добавить("Волков Волк Волкович");
ИсходныеДанные.Добавить("Зайцев Заяц Зайцевич");
ИсходныеДанные.Добавить("Медведев Медведь Медведевич");
ИсходныеДанные.Добавить("Лисицын Лис Лисович");
ИсходныеДанные.Добавить("Ежов Еж Ежович");
ИсходныеДанные.Добавить("Бобров Бобр Бобрович");
ИсходныеДанные.Добавить("Федоров Федор Федорович"); // 16-й
ИсходныеДанные.Добавить("Николаев Николай Николаевич"); // 17-й
ИсходныеДанные.Добавить("Владимиров Владимир Владимирович");
ИсходныеДанные.Добавить("Павлов Павел Павлович");
ИсходныеДанные.Добавить("Романов Роман Романович"); // 20-й
// --- Конец данных для демонстрации ---
// Счетчик строк на текущей странице.
СчетчикФИОНаСтранице = 0;
// Лимит строк на странице.
ЛимитСтрокНаСтранице = 8;
// --- Основной цикл обработки данных ---
Для каждого ФИО Из ИсходныеДанные Цикл
// Проверяем, не достигли ли мы лимита на предыдущей итерации.
// Если достигли, вставляем разрыв страницы и сбрасываем счетчик.
Если СчетчикФИОНаСтранице = ЛимитСтрокНаСтранице Тогда
ТабДок.ВывестиГоризонтальныйРазделительСтраниц();
СчетчикФИОНаСтранице = 0; // Сбрасываем счетчик для новой страницы
КонецЕсли;
// Получаем и заполняем область макета
ОбластьСтроки = Макет.ПолучитьОбласть("СтрокаФИО");
ОбластьСтроки.Параметры.ФИОМОЛ1 = ФИО;
// Выводим область. Используем ВЫВЕСТИ!
ТабДок.Вывести(ОбластьСтроки);
// Увеличиваем счетчик выведенных на текущую страницу строк
СчетчикФИОНаСтранице = СчетчикФИОНаСтранице + 1;
КонецЦикла;
Возврат ТабДок;
КонецФункции
Ключевые изменения в этом коде:
Присоединить заменен на Вывести, что соответствует его назначению для построчного формирования документа.ТабДок.ПроверитьВывод(), которая в данном контексте не всегда является необходимой и может усложнять логику. Метод ПроверитьВывод полезен для более сложных сценариев, например, когда требуется точно знать, поместится ли составная область целиком.Хотя стандартные инструменты не выявляют эту проблему напрямую, некоторые из них, например BSL Language Server, предоставляют возможности для создания пользовательских правил (линтеров). Мы можем попытаться создать такое правило, которое будет сигнализировать о потенциально некорректном использовании метода Присоединить.
BSL Language Server — это консольное Java-приложение, предназначенное для статического анализа кода 1С. Он может быть интегрирован с различными интегрированными средами разработки, такими как Visual Studio Code (через расширение Language 1C (BSL)) и 1C:Enterprise Development Tools (EDT). BSL Language Server позволяет выполнять следующие задачи:
Он работает, разбирая тексты модулей в синтаксические деревья, строя объектную модель метаданных и контекст проекта, а затем ищет нарушения и рассчитывает метрики.
BSL Language Server позволяет изменять настройки по умолчанию и добавлять свои проверки с помощью конфигурационного файла .bsl-language-server.json, который обычно располагается в корне проекта. В этом файле мы можем определить простое правило, которое будет искать в коде ключевое слово "Присоединить" и выдавать предупреждение.
Пример такого пользовательского правила:
{
"language": "ru",
"diagnostics": {
"computeTrigger": "onType",
"parameters": {
"НеиспользуемаяПеременная": true,
"ИспользованиеМодальныхОкон": false,
"ИспользованиеСинхронныхВызовов": false,
"МагическоеЧисло": {
"check": true,
"allowed": [0, 1, 2, 3, 10, 100, 1000]
}
},
"custom": [
{
"name": "ПодозрительноеИспользованиеПрисоединить",
"check": "Присоединить",
"message": "Обнаружено 'Присоединить'. Этот метод добавляет колонки справа. Для вывода строк обычно используется 'Вывести'. Проверьте, что это неошибка."
}
]
}
}
В этом примере мы добавили пользовательское правило с именем ПодозрительноеИспользованиеПрисоединить. Оно настроено на поиск строкового выражения "Присоединить" ("check": "Присоединить") и при обнаружении выдает сообщение "Обнаружено 'Присоединить'. Этот метод добавляет колонки справа. Для вывода строк обычно используется 'Вывести'. Проверьте, что это неошибка.".
Ограничения пользовательского правила:
Такой подход имеет свои ограничения:
Присоединить используется абсолютно корректно (например, для вывода колонок).Для создания более "умного" правила, которое бы точно определяло, когда Присоединить используется некорректно для построчного вывода, потребовался бы глубокий синтаксический и семантический анализ, который выходит за рамки возможностей простых пользовательских правил в BSL Language Server.
Рассмотрим, как другие упомянутые инструменты справляются с общими задачами анализа кода в 1С:
sonar-bsl-plugin-community и плагин от компании «Серебряная пуля». SonarQube может быть интегрирован в CI/CD конвейеры для автоматической проверки качества кода. Хотя настройка SonarQube "с нуля" может быть сложной, существуют готовые Docker-сборки, которые упрощают его развертывание. SonarQube хорош для общих проверок качества, безопасности и производительности, но, как и BSL Language Server, столкнется с трудностями при выявлении тонких семантических ошибок без специально разработанных, очень сложных правил.ТабличныйДокумент.Все эти инструменты очень полезны для поддержания общего качества кода, автоматизации обнаружения стандартных проблем и соблюдения стандартов кодирования. Однако они не заменят глубокого понимания платформы и ручного код-ревью для выявления таких специфических семантических нюансов, как различие между Присоединить и Вывести в контексте построчного вывода.
Мы видим, что автор темы пробовал использовать ИИ (Gemini) для анализа кода. В данном случае, ИИ предоставил рефакторинг кода, заменив Присоединить на Вывести и упростив логику разбиения на страницы. Однако важно отметить:
Присоединить как проблему, а скорее предложил "более оптимальный" или "стандартный" способ реализации. Он рефакторизировал код, а не выявил критическую ошибку, которая препятствует работе.Это подчеркивает, что даже передовые ИИ-системы пока не могут полностью заменить человека в задачах, требующих глубокого контекстуального анализа и понимания неявных требований или неописанных в документации нюансов поведения системы. Всегда включайте критическое мышление при работе с кодом, сгенерированным или проанализированным ИИ.
Обсуждение в теме также затрагивает более общие вопросы качества кода и его структуры. Рефакторинг — это процесс изменения кода с целью сделать его чище, повысить читаемость и улучшить структуру, не изменяя при этом изначального смысла и внешнего поведения. Инструменты рефакторинга в 1С:Конфигураторе и 1C:EDT помогают в этом, предлагая функции вроде "Выделить фрагмент" (для создания процедур/функций) или "Переименовать".
В контексте предоставленного кода, даже если бы Присоединить работал "правильно", сам код можно было бы улучшить с точки зрения структуры и читаемости. Например, блок инициализации демонстрационных данных можно вынести в отдельную вспомогательную функцию. Такие практики, как разделение бизнес-логики на отдельные части (получение данных, их обработка, использование), делают код более модульным, понятным и легче поддерживаемым, что в свою очередь снижает вероятность появления семантических ошибок.
Выявление тонких семантических ошибок, таких как некорректное использование Присоединить вместо Вывести в ТабличныйДокумент, является сложной задачей для автоматизированных инструментов статического анализа. Это связано с тем, что код синтаксически корректен, а кажущееся "правильное" поведение в простых сценариях скрывает фундаментальные различия в работе методов.
Наиболее эффективным подходом к решению данной проблемы является комбинация следующих методов:
Помните, что инструменты автоматического анализа кода — это лишь помощники. Они значительно упрощают поиск типовых проблем, но не заменяют критического мышления, глубоких знаний платформы и человеческого анализа контекста.