| Снегопат https://snegopat.ru/forum/ |
|
| Генератор документации - есть в природе? https://snegopat.ru/forum/viewtopic.php?f=3&t=749 |
Страница 1 из 1 |
| Автор: | 1823244 [ 29 сен 2016, 19:00 ] |
| Заголовок сообщения: | Генератор документации - есть в природе? |
Добрый день. А существуют ли наработки по этому вопросу? Например по-аналогии с http://www.1cpp.ru/forum/YaBB.pl?num=1209560079 Или же адаптация существующих генераторов, вроде doxygen? |
|
| Автор: | orefkov [ 29 сен 2016, 19:48 ] |
| Заголовок сообщения: | Re: Генератор документации - есть в природе? |
Ну, документация к самому снегопату генерится на лету из текстов в формате markdown. Из скриптов выделяется текст между комментариями /*@ .... @*/ Но какой-то особой заточки под язык 1С, чтобы учитывался синтаксис - нет. Возможно, что-то подобное есть в инструментах разработчика, что можно было бы взять за основу. |
|
| Автор: | Const1C [ 20 окт 2016, 13:38 ] |
| Заголовок сообщения: | Re: Генератор документации - есть в природе? |
Классная идея кстати. Т.к. 1С и снегопат в принципе умеет парсить комментарии, можно без труда запилить документацию. Достаточно пробежаться по всем экспортным функциям и процедурам, распарсить их комментарии (в заголовки) и получить некую доку по API. |
|
| Автор: | JohnyDeath [ 20 окт 2016, 16:45 ] |
| Заголовок сообщения: | Re: Генератор документации - есть в природе? |
Обсуждали в чатике gitter. Есть скрипты на OneScript, которые делают что-то похожее. Но готового пока ничего нет. Основной момент - кто будет пользоваться этими доками? Для кого они? |
|
| Автор: | 1823244 [ 28 окт 2016, 23:02 ] |
| Заголовок сообщения: | Re: Генератор документации - есть в природе? |
Доки для разработчиков. Пример: у нас 3 девелопера в команде, плюс еще архитектор иногда пописывает:) за 3 года работы накопилось уже два десятка функций (всего наверное около 1000) дублирующих друг друга. Вероятно, этого можно избежать, если будет документация. А также доки нужны для того, чтобы изучить, хотя-бы поверхностно, функционал, созданных коллегами. |
|
| Автор: | Const1C [ 31 окт 2016, 10:07 ] |
| Заголовок сообщения: | Re: Генератор документации - есть в природе? |
Тут важно, что бы эти доки экспортировались в CHM формат (или его эквивалент). Тогда прежде чем что-то написать, будет достаточно пробежаться в поиске. Это будет полезно и для стандартных подсистем и конфигураций. Т.к. количество экспортных процедур в них измеряется тысячами их код можно изучать до пенсии. А так хоть какое-то подспорье будет. |
|
| Страница 1 из 1 | Часовой пояс: UTC + 3 часа |
| Powered by phpBB® Forum Software © phpBB Group http://www.phpbb.com/ |
|