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

16.01.14

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

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

Скачать файлы

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

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

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

 

См. также

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

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

Набор инструментов программиста и специалиста 1С для всех конфигураций на управляемых формах. В состав входят инструменты: Консоль запросов, Консоль СКД, Консоль кода, Редактор объекта, Анализ прав доступа, Метаданные, Поиск ссылок, Сравнение объектов, Все функции, Подписки на события и др. Редактор запросов и кода с раскраской и контекстной подсказкой. Доработанный конструктор запросов тонкого клиента. Продукт хорошо оптимизирован и обладает самым широким функционалом среди всех инструментов, представленных на рынке.

13000 руб.

02.09.2020    119910    656    389    

701

Infostart PrintWizard

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

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

18000 руб.

06.10.2023    7007    20    6    

37

Infostart УДиФ: Управление данными и формами

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

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

10000 руб.

10.11.2023    3244    10    1    

31

SALE! 30%

PowerTools

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

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

3600 2520 руб.

14.01.2013    177341    1070    0    

846

Многопоточность. Универсальный «Менеджер потоков» 2.1

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

Восстановление партий или взаиморасчетов, расчет зарплаты, пакетное формирование документов или отчетов - теперь все это стало доступнее. * Есть желание повысить скорость работы медленных алгоритмов! Но... * Нет времени думать о реализации многопоточности? * о запуске и остановке потоков? * о поддержании потоков в рабочем состоянии? * о передаче данных в потоки и как получить ответ из потока? * об организации последовательности? Тогда ЭТО - то что надо!!!

5000 руб.

07.02.2018    99203    239    97    

296

[ЕХТ] Фреймворк для Расширений 1С

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

"Фреймворк для Расширений 1С" это универсальное и многофункциональное решение, упрощающее разработку и поддержку создаваемых Расширений. Поставляется в виде комплекта из нескольких Расширений с открытым исходным кодом. Работает в любых Конфигурациях в режиме Управляемого приложения с режимом совместимости 8.3.12 и выше без необходимости внесения изменений в Конфигурацию.

3000 руб.

27.08.2019    17910    6    8    

38

1С HTML Шаблоны / HTML Templates

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

Быстрая и удобная обработка для работы с шаблонами HTML. Позволяет легко и быстро формировать код HTML.

2040 руб.

27.12.2017    27945    3    10    

14

Выполнение произвольного кода или запроса с параметрами через Web-сервис (замена COM-подключений)

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

В процессе работы в 1С часто возникает потребность получить данные из другой базы.  Обычно это делается через COM-соединение, и время выполнения запроса при этом оставляет желать лучшего. В данной публикации представлено универсальное решение, позволяющее практически моментально выполнить произвольный код или запрос с параметрами в другой информационной базе через Web-сервис.

2400 руб.

24.09.2019    23488    15    15    

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

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

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

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


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

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

Данную статью я опубликовал только из-за Артур Аюханов, который плюсанул за нее когда она была в черновом варианте, без описания совсем. Думал отделуюсь коротким хау-ту, ан нет придется писать, что такое ант, что такое доксиген.
6. artbear 1447 21.01.14 19:15 Сейчас в теме
(5) Рад, что мой плюсик сработал :)
ЗЫ Исправь, пожалуйста, мое ФИО на "Артур Аюханов"
7. awk 741 21.01.14 19:19 Сейчас в теме
(6) artbear, Прости, не со зла... Стыдно....
8. so-quest 140 22.01.14 06:22 Сейчас в теме
Зеркало есть для разработки? А то этих маней нет (и не будет видимо никогда :) )
10. awk 741 22.01.14 10:18 Сейчас в теме
(8) so-quest, Да вроде на ассамблее было..
9. dock 44 22.01.14 07:49 Сейчас в теме
Вещь хорошая, жаль что мне пока не нужная :)
Автору почет и уважение.
11. wolfsoft 2421 22.01.14 15:37 Сейчас в теме
В 1С надо ссылку отправить, может хоть тогда у них документация начнёт соответствовать коду...
12. awk 741 22.01.14 15:52 Сейчас в теме
(11) wolfsoft, А мы где? Территория инфостарт на половину принадлежит 1С.
13. webester 26 23.01.14 09:56 Сейчас в теме
Необходимость в документировании, возникает при написании подсистем и работе в команде, я работаю уже много лет соло, да и подсистем не писал никогда. Но плюсану вдруг понадобится :)
14. awk 741 23.01.14 10:05 Сейчас в теме
(13) webester, :))) Необходимость документирования обычно возникает гораздо позже написания (не важно в команде или в подсистеме). Правда возникает не в ста процентов случаев. Вот и получается - когда пишем, то ориентируемся на случай: "Авось не понадобится", а когда переписываем, то материмся на: "Суцко. Таки понадобилось".
15. ixijixi 1761 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 741 11.03.14 10:31 Сейчас в теме
20. nicxxx 254 30.09.16 15:20 Сейчас в теме
а можно дополнить руководство разделом по настройке ANT ? а то сходу не понятно нифига:) да и времени на его подробное изучение нет :(
21. nicxxx 254 06.10.16 18:07 Сейчас в теме
Не работает алгоритм:( Почему-то не конвертируются файлы выгрузки из 1С в файлы java, вот этот пункт из описания: "Второй плагин ни делает ничего, кроме выгрузки модулей 1С и преобразования их в код на подобии java."
22. nicxxx 254 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 остается пустым, в то время, как остальные файлы сформированы.
Оставьте свое сообщение