Снегопат

Обсуждение Снегопата
Текущее время: 20 июл 2019, 19:44

Часовой пояс: UTC + 4 часа [ Летнее время ]




Начать новую тему Ответить на тему  [ Сообщений: 6 ] 
Автор Сообщение
СообщениеДобавлено: 29 сен 2016, 21:00 
Не в сети

Зарегистрирован: 02 июл 2016, 00:23
Сообщения: 7
Добрый день.
А существуют ли наработки по этому вопросу?
Например по-аналогии с http://www.1cpp.ru/forum/YaBB.pl?num=1209560079
Или же адаптация существующих генераторов, вроде doxygen?


Вернуться к началу
 Профиль  
 
СообщениеДобавлено: 29 сен 2016, 21:48 
Не в сети
Администратор

Зарегистрирован: 24 авг 2011, 17:04
Сообщения: 1917
Ну, документация к самому снегопату генерится на лету из текстов в формате markdown.
Из скриптов выделяется текст между комментариями /*@ .... @*/
Но какой-то особой заточки под язык 1С, чтобы учитывался синтаксис - нет.
Возможно, что-то подобное есть в инструментах разработчика, что можно было бы взять за основу.


Вернуться к началу
 Профиль  
 
СообщениеДобавлено: 20 окт 2016, 15:38 
Не в сети

Зарегистрирован: 07 дек 2012, 10:20
Сообщения: 88
Классная идея кстати. Т.к. 1С и снегопат в принципе умеет парсить комментарии, можно без труда запилить документацию. Достаточно пробежаться по всем экспортным функциям и процедурам, распарсить их комментарии (в заголовки) и получить некую доку по API.


Вернуться к началу
 Профиль  
 
СообщениеДобавлено: 20 окт 2016, 18:45 
Не в сети

Зарегистрирован: 24 авг 2011, 17:32
Сообщения: 709
Обсуждали в чатике gitter. Есть скрипты на OneScript, которые делают что-то похожее. Но готового пока ничего нет.
Основной момент - кто будет пользоваться этими доками? Для кого они?


Вернуться к началу
 Профиль  
 
СообщениеДобавлено: 29 окт 2016, 01:02 
Не в сети

Зарегистрирован: 02 июл 2016, 00:23
Сообщения: 7
Доки для разработчиков. Пример: у нас 3 девелопера в команде, плюс еще архитектор иногда пописывает:) за 3 года работы накопилось уже два десятка функций (всего наверное около 1000) дублирующих друг друга. Вероятно, этого можно избежать, если будет документация. А также доки нужны для того, чтобы изучить, хотя-бы поверхностно, функционал, созданных коллегами.


Вернуться к началу
 Профиль  
 
СообщениеДобавлено: 31 окт 2016, 12:07 
Не в сети

Зарегистрирован: 07 дек 2012, 10:20
Сообщения: 88
Тут важно, что бы эти доки экспортировались в CHM формат (или его эквивалент). Тогда прежде чем что-то написать, будет достаточно пробежаться в поиске. Это будет полезно и для стандартных подсистем и конфигураций. Т.к. количество экспортных процедур в них измеряется тысячами их код можно изучать до пенсии. А так хоть какое-то подспорье будет.


Вернуться к началу
 Профиль  
 
Показать сообщения за:  Поле сортировки  
Начать новую тему Ответить на тему  [ Сообщений: 6 ] 

Часовой пояс: UTC + 4 часа [ Летнее время ]


Кто сейчас на конференции

Сейчас этот форум просматривают: нет зарегистрированных пользователей и гости: 3


Вы не можете начинать темы
Вы не можете отвечать на сообщения
Вы не можете редактировать свои сообщения
Вы не можете удалять свои сообщения
Вы не можете добавлять вложения

Найти:
Перейти:  
cron
Создано на основе phpBB® Forum Software © phpBB Group
Русская поддержка phpBB