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

Junior
446 просмотров
AFK Offer AI

Документация в Go — это комментарии прямо перед объявлением. // User represents a registered user. Первое предложение — summary, начинается с имени. Для пакета — comment перед package declaration или отдельный doc.go файл. godoc автоматически генерирует документацию из комментариев. Примеры кода — через Example функции в _test.go файлах. Не пиши очевидное: // GetUser gets user — бесполезно. Пиши зачем и когда: // GetUser returns the user by ID. Returns ErrNotFound if the user does not exist.

Следующий вопрос

Чем zerolog отличается от zap?