原书出处
Effective Go中文版
03 注释
序包内容的文档。在顶层声明之前出现,并且中间没有换行的注释,会随着声明一起被抽取,作为该项的解释性文本。这些注释的本质和风格决定了godoc所产生文档的质量。
每个程序包都应该有一个包注释,一个位于package子句之前的块注释。对于有多个文件的程序包,包注释只需要出现在一个文件中,任何一个文件都可以。包注释应该用来介绍该程序包,并且提供与整个程序包相关的信息。
它将会首先出现在godoc页面上,并会建立后续的详细文档。 /* Package regexp implements a simple library for
原书定位详情
来源:a19c7933-4eda-4176-aebd-30fe7e1ad292
正文位置:extracted/Effective Go中文版/_epub-src/OEBPS/注释.md.html
EPUB SHA-256:0fe00b742c425a3cbfb1dcf5db8f9ab889cfbd7ca3a4e3be39bba5876b63c1c7