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

Как документировать код? #2

Open
EmillkaakillmE opened this issue Feb 24, 2022 · 1 comment
Open

Как документировать код? #2

EmillkaakillmE opened this issue Feb 24, 2022 · 1 comment

Comments

@EmillkaakillmE
Copy link

EmillkaakillmE commented Feb 24, 2022

Установка и генерация .yaml файла прошла успешно. Но не совсем понимаю, как писать документацию, кроме как верстать этот файл статично
Роуты все позадавал, как в инструкции, в .settings настройку выставил.. А дальше как?😅

Ожидал чего-то вроде https://justcodeit.ru/swagger-docs-dlya-api-na-laravel/
Создание документации с помощью комментариев прямо над методами/классами. А как в итоге не совсем понимаю
Скажите пожалуйста, такой вариант вообще возможен? Если да, то прошу, направьте хоть, куда копать)

@north-leshiy
Copy link
Member

north-leshiy commented Mar 5, 2022

Да, все также, аннотируете методы контроллеров комментариями, генерируется документация.

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

2 participants