Tencent Cloud Developer

Apr 6, 2022 · Backend Development

Writing Effective GoDoc: Using godoc, pkgsite and GoDoc Syntax with Examples

This guide explains how to write effective GoDoc by installing and using the godoc and pkgsite tools, applying proper comment syntax, handling package overviews, deprecation notices, and example tests, and publishing documentation on pkg.go.dev with badges, illustrated through the go.jsonvalue library.