Автоматическое формирование документации из исходников


#1

Возможно, уже кто-то заморачивался автоматической подготовкой документации из исходников 1С.
Т.е., допустим, у меня есть модуль, в нем есть экспортные функции/процедуры (API т.е.), и я написал к ним описания согласно стандарту.
Нет ли уже готового инструмента для формирования текстового файлика (a la синтакс-помощник) с описанием API из таких сырцов?


#2

@1cgh Это тебе к @lustin :smile:, я видел, он играется!


#3

Он на такое отвечал, что забросили эту идею, т. к. нет целевой аудитории. Не понятно для кого будут генерироваться эти доки и зачем. Я теперь тоже согласен с этим мнением


#4

@JohnyDeath Но я на днях смотрел немного про другие доки у него.


#5

У меня работает несколько лет, но публиковать не вижу смысла. Все слишком индивидуально.

Если кратко: самописный парсер + либа конфлюенс + Женька + гитлаб


#6

Могу завтра скрин скинуть, если интересно.


#7

А почему не опубликовать! Мне вот тоже надо автодокументатор для АПИ!


#8

На партнерке выкладывали обработку, которая генерит описание БСП для ИТС


#9

@nixel2007 А где найти можно? Интересно глянуть.


#10

Хм. На мой взгляд всё довольно просто. Есть вроде бы стандартный механизм 1С, который тебе при обращении к функции/процедуре с адекватным описанием даст соответствующую подсказку в пофигураторе. Но он подразумевает, что ты знаешь о её существовании. Наличие же актуального описания API продукта в общей базе знаний (Confluence, wiki, etc) дает возможность найти нужную функцию/процедуру разработчику без изобретения своего лисапеда.


#11

Дайдайдай)


#12

Если не жалко. Ибо назрело))


#13

гы как интересно - ну вот вам в ленту. Скажем так - реанимировал.


#14

Кажется обработка с партнёрки вот Генерация описания программного интерфейса Но может я перепутал, и это что-то с инфостарта.
Если не открывается или наоборот, даёт доступ ко всему моему дропбоксу маякните.


#15

Обещанные картинки


#16

пример обработки вложенных областей


#17

Круто ж!! А движок какой - wiki?


#18

Очень похоже на Confluense


#19

Да, хелп в confluence, для отображения 1с кода используется соответствующий плагин.

Поэтому я и говорил, что постить смысла нет - слишком много звезд долно сойтись для того, чтобы все получилось красиво.


#20

Да и пусть некрасиво. Хотя бы идею почерпнуть.