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

16.01.14

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

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

Скачать файл

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

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

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

Установить ант
Настроить ант
Запустить ант
Написать комментарии в коде

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. Прошу прощенья, если описание не внятно. Но описание я пишу почти через год после написания программы. Может чего и забыл.

+26 –1

См. также

Infostart Toolkit — Инструменты разработчика 1С 8.3

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

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

15500 руб.

02.09.2020 175567 976 403

933

Database Compression Tool: Инструмент для свертки и сжатия баз данных 1С

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

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

8400 руб.

20.08.2024 17167 120 59

121

Infostart PrintWizard (конструктор печатных форм)

Пакетная печать Печатные формы Инструментарий разработчика Программист Платформа 1С v8.3 Запросы 1С:Зарплата и кадры бюджетного учреждения 1С:ERP Управление предприятием 2 1С:Управление торговлей 11 Платные (руб)

Инструмент, позволяющий абсолютно по-новому взглянуть на процесс разработки печатных форм. Благодаря конструктору можно значительно снизить затраты времени на разработку печатных форм, повысить качество и "прозрачность" разработки, а также навести порядок в многообразии корпоративных печатных форм.

22200 руб.

06.10.2023 18234 49 19

OneDebugger - инструмент для отладки кода в 1С без использования конфигуратора

Инструментарий разработчика Программист Платформа 1С v8.3 Платные (руб)

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

9360 руб.

17.05.2024 28352 98 48

143

Infostart DataFormWizard: Управление данными и формами 1С 8.3

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

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

15000 руб.

10.11.2023 12462 49 33

SALE! %

PowerTools: Инструменты администратора 1С 8.3

Инструментарий разработчика Инструменты администратора БД Системный администратор Программист Платформа 1С v8.3 Управляемые формы 1C:ERP 1С:УТ 1С:ДО 1С:Бухгалтерия 3.0 1С:ERP. Управление холдингом 1С:Зарплата и Управление Персоналом 3.x 1С:Управление нашей фирмой 3.0 1С:Управление торговлей 11 Россия Платные (руб)

Универсальный инструмент программиста для администрирования конфигураций. Сборник наиболее часто используемых обработок под единым интерфейсом.

~~4800~~ 3840 руб.

14.01.2013 192453 1155 0

921

Бустер Конвертации данных 3 (Infostart Toolkit)

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

Расширение для конфигурации “Конвертация данных 3”. Добавляет подсветку синтаксиса, детальную контекстную подсказку, глобальный поиск по коду.

20000 руб.

07.10.2021 18423 7 32

Конструктор АРМ

Инструментарий разработчика Платформа 1С v8.3 1C:Бухгалтерия 1С:ERP Управление предприятием 2 Платные (руб)

Разработка Конструктор автоматизированных рабочих мест "Конструктор АРМ" реализована в виде расширения и является универсальным инструментом для создания АРМ любой сложности в пользовательском режиме.

3600 руб.

27.12.2024 1517 2 0

Комментарии

Подписаться на ответы Инфостарт бот

Свернуть все

1. script 128 16.01.14 23:17 Сейчас в теме

Ничего не понял вообще. Понятно только что документация, но какая и для чего и как настроить что бы заработало и что должно получится. Все равно что посадить пользователя, который работал на 7.7., перед УПП и сказать: Вот...

2. awk 745 17.01.14 00:47 Сейчас в теме

(1) script,

Понятно только что документация, но какая и для чего

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

как настроить что бы заработало

Ну если вкурсе про ант, и doxigen - то подправить конфиги, а если нет - читать документаци по ант и доксигену.

что должно получится

А что бы вы хотели?

Все равно что посадить пользователя, который работал на 7.7., перед УПП и сказать: Вот.

В точку. Современные системы проектировани по сравнению с конфигуратором, как самолет и самокат. Токо что слова одинаковые "само".

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

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

3. awk 745 17.01.14 01:48 Сейчас в теме

(1) script, Наверное, вам больше подойдет http://infostart.ru/public/88910/. Примерно то же самое, но используется только Power Shell.

4. Поручик 4666 19.01.14 02:02 Сейчас в теме

Для рядового одноэсника страница из разряда - долго читал, много думал.

5. awk 745 19.01.14 02:15 Сейчас в теме

(4) Поручик, Для рядового одинесника (да простят меня на сайте - сам такой) много читал и думал - не свойственно. На все мои попытки что-то новое привить мои коллеги обычно отвечают - "Зачем и так деньги платят. Развиваться надо когда делать нечего."

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

6. artbear 1566 21.01.14 19:15 Сейчас в теме

(5) Рад, что мой плюсик сработал :)
ЗЫ Исправь, пожалуйста, мое ФИО на "Артур Аюханов"

7. awk 745 21.01.14 19:19 Сейчас в теме

(6) artbear, Прости, не со зла... Стыдно....

8. so-quest 140 22.01.14 06:22 Сейчас в теме

Зеркало есть для разработки? А то этих маней нет (и не будет видимо никогда :) )

10. awk 745 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 745 22.01.14 15:52 Сейчас в теме

(11) wolfsoft, А мы где? Территория инфостарт на половину принадлежит 1С.

13. webester 26 23.01.14 09:56 Сейчас в теме

Необходимость в документировании, возникает при написании подсистем и работе в команде, я работаю уже много лет соло, да и подсистем не писал никогда. Но плюсану вдруг понадобится :)

14. awk 745 23.01.14 10:05 Сейчас в теме

(13) webester, :))) Необходимость документирования обычно возникает гораздо позже написания (не важно в команде или в подсистеме). Правда возникает не в ста процентов случаев. Вот и получается - когда пишем, то ориентируемся на случай: "Авось не понадобится", а когда переписываем, то материмся на: "Суцко. Таки понадобилось".

15. ixijixi 1988 23.01.14 17:23 Сейчас в теме

(13) Ага, тоже плюсанул "на потом почитать" =)

16. rasswet 82 24.01.14 10:25 Сейчас в теме

к сожалению ничего не понял.

17. webester 26 26.01.14 06:01 Сейчас в теме

(16) значит вам это не нужно :)

18. pumbaE 10.03.14 18:52 Сейчас в теме

Стандартные комментарии 1С, преобразовывает в формат doxygen?

// Устанавливает статус для объекта документа
//
// Параметры:
//	НовыйСтатус - Строка - Имя статуса, который будет установлен у заказов
//	ДополнительныеПараметры - Структура - Структура дополнительных параметров установки статуса
//
// Возвращаемое значение:
//	Булево - Истина, в случае успешной установки нового статуса
//
Функция УстановитьСтатус(НовыйСтатус, ДополнительныеПараметры) Экспорт

Показать

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

19. awk 745 11.03.14 10:31 Сейчас в теме

(18) pumbaE, Нет.

20. nicxxx 255 30.09.16 15:20 Сейчас в теме

а можно дополнить руководство разделом по настройке ANT ? а то сходу не понятно нифига:) да и времени на его подробное изучение нет :(

21. nicxxx 255 06.10.16 18:07 Сейчас в теме

Не работает алгоритм:( Почему-то не конвертируются файлы выгрузки из 1С в файлы java, вот этот пункт из описания: "Второй плагин ни делает ничего, кроме выгрузки модулей 1С и преобразования их в код на подобии java."

22. nicxxx 255 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 остается пустым, в то время, как остальные файлы сформированы.