Как создать документацию в html при помощи godoc?

204 views
Skip to first unread message

Inno Bragovich

unread,
Feb 15, 2018, 8:21:46 AM2/15/18
to Golang Russian
Всем привет!
Собственно, сабж - есть ли возможность сгенерить документацию на основе каментов в коде?
Не могу найти внятного описания или примеров ни на офсайте, ни в гугле. 

Evgeny Khabarov

unread,
Feb 15, 2018, 2:48:19 PM2/15/18
to gola...@googlegroups.com
Привет!

Вот тут подробно описано:

FAQ: https://golang.org/doc/faq#How_are_libraries_documented
Go blog: https://blog.golang.org/godoc-documenting-go-code
Effective Go: https://golang.org/doc/effective_go.html#commentary

--
Best regards,
Evgeny Khabarov
PGP:
90E1 2534 39FC 462C AE5B
DF25 B812 562B BC41 9145
> --
> Вы получили это сообщение, поскольку подписаны на группу Golang Russian.
>
> Чтобы отменить подписку на эту группу и больше не получать от нее сообщения,
> отправьте письмо на электронный адрес golang-ru+...@googlegroups.com.
> Настройки подписки и доставки писем: https://groups.google.com/d/optout.

signature.asc

Inno Bragovich

unread,
Feb 16, 2018, 7:07:10 AM2/16/18
to Golang Russian
Приветствую!
Я все эти разделы видел, и в них не написано ни описания того, как делать то, о чём я спрашиваю, ровно как и нету ни одного примера.

Ilya Ozherelyev

unread,
Feb 16, 2018, 9:18:14 AM2/16/18
to Golang Russian
Почитайте про swagger или raml

http://bigk.me/swagger/golang/go/2017/07/30/golang-and-openapi-how-to-create-documentation-for-your-rest-api-services/

четверг, 15 февраля 2018 г., 16:21:46 UTC+3 пользователь Inno Bragovich написал:

Inno Bragovich

unread,
Mar 8, 2018, 3:32:49 AM3/8/18
to Golang Russian
Спасибо, посмотрю. Не дошёл ещё (
Reply all
Reply to author
Forward
0 new messages