Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Автогенерация документации программного интерфейса. #7

Open
alex-bob-lip opened this issue Dec 12, 2022 · 1 comment

Comments

@alex-bob-lip
Copy link
Owner

Написать скрипт для автогенерации документации программного интерфейса библиотеки.
Скрипт должен анализировать файл lib.config, определять из него имена классов и модулей и пути к ним.
В файлах модулей и классов должна быть область ПрограммныйИнтерфейс с экспортными методами.
Методы должны иметь описания, соответствующие стандартам 1С.
Дополнительно, для больших модулей обеспечить возможность разбивки документации методов на подразделы с помощью областей, вложенных в область ПрограммныйИнтерфейс.
Опционально, обеспечить возможность показа раскрашенного кода примеров вызова методов.
Сгенерированная документация должна иметь формат html.

@alex-bob-lip
Copy link
Owner Author

Еще было-бы хорошо иметь возможность включать в документацию файлы перечислений, в виде таблицы

  • имя, описание, значение.

alex-bob-lip added a commit that referenced this issue Dec 12, 2022
Issue #7
Сгенерирована документация в формате html
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant