search

Shadawn / A1-Export

Коллектив "А1" - экспортная библиотека для 1С
MIT License
69 stars 19 forks source link

Документация #3

Open Shadawn opened 4 years ago

Shadawn commented 4 years ago

Было бы круто, если бы у библиотеки была цивилизованная веб-документация. Было бы еще круче, если бы её можно было бы сгенерировать из комментариев к коду а-ля JavaDoc, JSDoc и им подобные. Если у кого-нибудь уже есть аналогичное решение для 1С - я бы с удовольствием воспользовался. Если нет - видимо потребуется писать самому.

malikov-pro commented 4 years ago

"а-ля JavaDoc, JSDoc и им подобные" - не встречал, нужная штука, мне для документирования API например. В головном описании не хватает ссылки на infostart В головное описание нужно добавить оглавление, в этом тикете описать формат оформления раздела. Вариант работы: нужен блок, посмотрел по оглавлению, если нет описания, то нашел в коде, задал вопросы в issue, по результату использования описал. вариант расширение перенести в папку /cfe и использовать precommit1c, он соответственно создаст папку /src/cfe