Документирование 1С через комментарии

16.01.14

Разработка - Инструментарий разработчика

Для языков программирования Java, C++, C# и т.д. Созданы системы строящие документацию, через комментарии. А можно ли такое же в 1С?

Файлы

ВНИМАНИЕ: Файлы из Базы знаний - это исходный код разработки. Это примеры решения задач, шаблоны, заготовки, "строительные материалы" для учетной системы. Файлы ориентированы на специалистов 1С, которые могут разобраться в коде и оптимизировать программу для запуска в базе данных. Гарантии работоспособности нет. Возврата нет. Технической поддержки нет.

Наименование Скачано Купить файл
Ант задача конвертирующая 1С тексты в ал-я java
.jar 8,02Kb
13 2 500 руб. Купить
Пример конфигурационного файла doxygen
.dox 76,91Kb
14 2 500 руб. Купить
Настройки анта
.xml 1,94Kb
13 2 500 руб. Купить

Подписка PRO — скачивайте любые файлы со скидкой до 85% из Базы знаний

Оформите подписку на компанию для решения рабочих задач

Оформить подписку и скачать решение со скидкой

Вы можете заказать платную доработку или адаптацию этой разработки под вашу конфигурацию на «Бирже заказов».

  • 0% комиссии — оплата напрямую исполнителю;
  • Исполнители любого масштаба — от отдельных специалистов до команд под проект;
  • Прямой обмен контактами между заказчиком и исполнителем;
  • Безопасная сделка — при необходимости;
  • Рейтинги, кейсы и прозрачная система откликов.

Можно. Для этого потребуется:

  1. Установить ант
  2. Настроить ант
  3. Запустить ант
  4. Написать комментарии в коде

1. Что же такое ант?

Apache Ant (англ.ant — муравей и акроним — «Another Neat Tool») — утилита для автоматизации процесса сборки программного продукта. Является платформонезависимым аналогом утилиты make (в качестве «Makefile» применяется «build.xml»).

(с) Википедия

Скачать эту замечательную утилиту можно по адресу: http://ant.apache.org/bindownload.cgi.

 

К данной замечательной утилите потребуется два плагина. Первый это плагин http://ant-doxygen.blogspot.ru/, а второй - это плагин к анту, написаный мной и прекрепленный к данной статье.

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

 

2. Как настроить ант?

К этой статье приложен файл: "build.xml", в нем надо заменить пути к файлам и значения, на ваши. Скачать и подправить файл настройки doxigen (так же приложен к данной статье).

3. Как запустить ант?

Запустить cmd.exe или PowerShell и перейти в каталог с файлом build.xml и запустить ant all.

4. Комментарии

Комментарии нужно оформить в стиле javadoc или doxigen, но есть маленькая специфика. Что бы ваша документация ложилаь по простанствам имен(пакетам) я добавил от себя следующие правила:

Если модуль начинается с комментария:

// $subsystem=[имя]

// [Какое-то описание]

// $

То это этот модуль попадет в [имя].ОбщийМодуль.ИмяОбщегоМодуля.

Если же такого комментария не будет, то он попадет в ОбщийМодуль.ИмяОбщегоМодуля.

5. Итог

Вуаля документация у вас готова.

 

P.S. Прошу прощенья, если описание не внятно. Но описание я пишу почти через год после написания программы. Может чего и забыл.

 

Вступайте в нашу телеграмм-группу Инфостарт

См. также

Инструментарий разработчика Чистка данных Свертка базы Инструменты администратора БД Системный администратор Программист Руководитель проекта 1С:Предприятие 8 1С:ERP Управление предприятием 2 1С:Бухгалтерия 3.0 1С:Управление торговлей 11 1С:Комплексная автоматизация 2.х 1С:Управление нашей фирмой 3.0 Россия Платные (руб)

Инструмент представляет собой обработку для проведения свёртки или обрезки баз данных. Работает на ЛЮБЫХ конфигурациях (УТ, БП, ERP, УНФ, КА и т.д.). Поддерживаются серверные и файловые базы, управляемые и обычные формы, формы интерфейса 8.5. Может выполнять свертку одновременно в несколько потоков. А так же автоматически, без непосредственного участия пользователя. Решение в Реестре отечественного ПО

24900 руб.

20.08.2024    71344    366    170    

317

Инструментарий разработчика Роли и права Запросы СКД Программист Руководитель проекта 1С:Предприятие 8 Платные (руб)

Инструменты для разработчиков 1С 8.3: Infostart Toolkit. Автоматизация и ускорение разработки на управляемых формах. Легкость работы с 1С.

16500 руб.

02.09.2020    261764    1460    421    

1170

Пакетная печать Печатные формы Инструментарий разработчика Программист 1С:Предприятие 8 Платные (руб)

Расширение для создания и редактирования печатных форм в системе 1С:Предприятие 8.3. Благодаря конструктору можно значительно снизить затраты времени на разработку печатных форм, повысить качество и прозрачность разработки, а также навести порядок в многообразии корпоративных печатных форм. Обновление версии от 21.04.26

22570 руб.

06.10.2023    38836    108    46    

122

Инструментарий разработчика Нейросети Платные (руб)

Первые попытки разработки на 1С с использованием больших языковых моделей (LLM) могут разочаровать. LLMки сильно галлюцинируют, потому что не знают устройства конфигураций 1С, не знают нюансов синтаксиса. Но если дать им подсказки с помощью MCP, то результат получается кардинально лучше. Далее в публикации: MCP для поиска по метаданным 1С, справке синтакс-помощника и проверки синтаксиса.

15250 руб.

25.08.2025    57750    117    32    

128

Мастера заполнения Поиск данных Инструментарий разработчика Подбор и обработка объектов 1С 8.3 1С 8.5 Платные (руб)

Infostart MagicInput улучшает подбор в полях ввода 1С: ищет по любой части названия и по нескольким ключевым фрагментам, распознаёт ввод в другой раскладке и показывает иконки/статусы объектов прямо в списке. Поддерживает вставку навигационной ссылки/представления документа для автоподбора; для разработчиков доступны поиск по GUID и полному имени предопределённого. Работает в управляемых формах и подключается в большинстве конфигураций 1С 8.3/8.5.

6000 руб.

25.02.2026    4097    13    1    

18

Инструментарий разработчика Разработка Администрирование веб-серверов Системный администратор Программист Бизнес-аналитик Руководитель проекта 1С 8.3 Платные (руб)

В крупных внедрениях 1С типовая почти всегда дополнена расширениями, а конфигуратор показывает их раздельно. «Поиск ссылок на объект» в ERP — минуты ожидания, и даже после него неясно: типовое поведение, дополнение из расширения или переопределённый обработчик. Analyzer 1C — веб-инструмент, который парсит выгрузку (основную плюс все расширения) и собирает единый граф знаний в ArangoDB. Любой межсущностный запрос — за доли секунды. Внутри: — Сквозные пометки «Доб.» / «Заимств.» / переопределения во всём UI — Импакт-анализ через подписки, регламентные задания и переопределения — Анализ запросов BSL: кто читает и пишет объект — модули, формы, СКД — Роли: матрица «роль × объект × право», RLS, программные РольДоступна, PRIV — Конструктор профилей, граф функций, обработчики обновления, XDTO, функциональные опции — Мгновенный поиск по конфигурации Разворачивается за минуту через Docker, без интернета. Любая 1С:Предприятие 8.3+.

12200 руб.

17.04.2026    6788    29    35    

44

Инструменты администратора БД Инструментарий разработчика Роли и права Программист 1С:Предприятие 8 1C:Бухгалтерия Россия Платные (руб)

Расширение позволяет без изменения кода конфигурации выполнять проверки при вводе данных, скрывать от пользователя недоступные ему данные, выполнять код в обработчиках. Не изменяет данные конфигурации, легко устанавливается практически на любую конфигурацию на управляемых формах.

17000 руб.

10.11.2023    25703    95    46    

102

Инструментарий разработчика Программист 1С:Предприятие 8 Платные (руб)

Инструмент для написания и отладки кода в режиме «1С:Предприятие». Представляет собой консоль кода с возможностью пошаговой отладки, просмотра значений переменных любых типов, использования процедур и функций, просмотра стека вызовов, вычисления произвольных выражений на встроенном языке в контексте точки останова, синтаксического контроля и остановки по ошибке. В консоли используется удобный редактор кода с подсветкой, контекстной подсказкой, возможностью вызова конструкторов запроса и форматной строки. 1.3.11 Доработан механизм контекстной подсказки по метаданным

9500 руб.

17.05.2024    53576    185    63    

217
Комментарии
Подписаться на ответы Инфостарт бот Сортировка: Древо развёрнутое
Свернуть все
1. script 128 16.01.14 23:17 Сейчас в теме
Ничего не понял вообще. Понятно только что документация, но какая и для чего и как настроить что бы заработало и что должно получится. Все равно что посадить пользователя, который работал на 7.7., перед УПП и сказать: Вот...
magic1s; AntonProgma; itoptimum; +3 Ответить
2. awk 746 17.01.14 00:47 Сейчас в теме
(1) script,
Понятно только что документация, но какая и для чего

Ну, вот такая как на скриншете. Для того кому надо.
как настроить что бы заработало

Ну если вкурсе про ант, и doxigen - то подправить конфиги, а если нет - читать документаци по ант и доксигену.
что должно получится
А что бы вы хотели?
Все равно что посадить пользователя, который работал на 7.7., перед УПП и сказать: Вот.
В точку. Современные системы проектировани по сравнению с конфигуратором, как самолет и самокат. Токо что слова одинаковые "само".

Ну это юмор. Надеюсь я им не обидел, а заставил улыбнутся.


А серьезно можно по порядку? Что непонятно? Где найти документацию по установке? Или как форматировать комментарии в доксиген стиле? Я попробую ответить на конкретные вопросы.

3. awk 746 17.01.14 01:48 Сейчас в теме
(1) script, Наверное, вам больше подойдет http://infostart.ru/public/88910/. Примерно то же самое, но используется только Power Shell.
4. Поручик 4612 19.01.14 02:02 Сейчас в теме
Для рядового одноэсника страница из разряда - долго читал, много думал.
5. awk 746 19.01.14 02:15 Сейчас в теме
(4) Поручик, Для рядового одинесника (да простят меня на сайте - сам такой) много читал и думал - не свойственно. На все мои попытки что-то новое привить мои коллеги обычно отвечают - "Зачем и так деньги платят. Развиваться надо когда делать нечего."

Данную статью я опубликовал только из-за Артур Аюханов, который плюсанул за нее когда она была в черновом варианте, без описания совсем. Думал отделуюсь коротким хау-ту, ан нет придется писать, что такое ант, что такое доксиген.
6. artbear 1588 21.01.14 19:15 Сейчас в теме
(5) Рад, что мой плюсик сработал :)
ЗЫ Исправь, пожалуйста, мое ФИО на "Артур Аюханов"
7. awk 746 21.01.14 19:19 Сейчас в теме
(6) artbear, Прости, не со зла... Стыдно....
8. so-quest 140 22.01.14 06:22 Сейчас в теме
Зеркало есть для разработки? А то этих маней нет (и не будет видимо никогда :) )
10. awk 746 22.01.14 10:18 Сейчас в теме
(8) so-quest, Да вроде на ассамблее было..
9. dock 45 22.01.14 07:49 Сейчас в теме
Вещь хорошая, жаль что мне пока не нужная :)
Автору почет и уважение.
11. wolfsoft 2421 22.01.14 15:37 Сейчас в теме
В 1С надо ссылку отправить, может хоть тогда у них документация начнёт соответствовать коду...
12. awk 746 22.01.14 15:52 Сейчас в теме
(11) wolfsoft, А мы где? Территория инфостарт на половину принадлежит 1С.
13. webester 26 23.01.14 09:56 Сейчас в теме
Необходимость в документировании, возникает при написании подсистем и работе в команде, я работаю уже много лет соло, да и подсистем не писал никогда. Но плюсану вдруг понадобится :)
14. awk 746 23.01.14 10:05 Сейчас в теме
(13) webester, :))) Необходимость документирования обычно возникает гораздо позже написания (не важно в команде или в подсистеме). Правда возникает не в ста процентов случаев. Вот и получается - когда пишем, то ориентируемся на случай: "Авось не понадобится", а когда переписываем, то материмся на: "Суцко. Таки понадобилось".
15. ixijixi 2152 23.01.14 17:23 Сейчас в теме
(13) Ага, тоже плюсанул "на потом почитать" =)
16. rasswet 82 24.01.14 10:25 Сейчас в теме
к сожалению ничего не понял.
SirYozha; +1 Ответить
17. webester 26 26.01.14 06:01 Сейчас в теме
(16) значит вам это не нужно :)
smit1c; SirYozha; +2 Ответить
18. pumbaE 10.03.14 18:52 Сейчас в теме
Стандартные комментарии 1С, преобразовывает в формат doxygen?
// Устанавливает статус для объекта документа
//
// Параметры:
//	НовыйСтатус - Строка - Имя статуса, который будет установлен у заказов
//	ДополнительныеПараметры - Структура - Структура дополнительных параметров установки статуса
//
// Возвращаемое значение:
//	Булево - Истина, в случае успешной установки нового статуса
//
Функция УстановитьСтатус(НовыйСтатус, ДополнительныеПараметры) Экспорт
Показать

В
// Устанавливает статус для объекта документа
//
// @param НовыйСтатус - Строка - Имя статуса, который будет установлен у заказов
// @param ДополнительныеПараметры {Структура} - Структура дополнительных параметров установки статуса
//
Функция УстановитьСтатус(НовыйСтатус, ДополнительныеПараметры) Экспорт


?
19. awk 746 11.03.14 10:31 Сейчас в теме
20. nicxxx 256 30.09.16 15:20 Сейчас в теме
а можно дополнить руководство разделом по настройке ANT ? а то сходу не понятно нифига:) да и времени на его подробное изучение нет :(
21. nicxxx 256 06.10.16 18:07 Сейчас в теме
Не работает алгоритм:( Почему-то не конвертируются файлы выгрузки из 1С в файлы java, вот этот пункт из описания: "Второй плагин ни делает ничего, кроме выгрузки модулей 1С и преобразования их в код на подобии java."
22. nicxxx 256 10.01.18 00:31 Сейчас в теме
Народ, кто-то вообще пробовал использовать doxygen?
Постоянно сталкиваюсь с ошибкой error: Could not open file Z:/temp/ant21cjava/doc/html/functions_.html for writing после шага Generating member index.
На этом создание документации прерывается и index.html остается пустым, в то время, как остальные файлы сформированы.
Для отправки сообщения требуется регистрация/авторизация