原书出处
Effective Go中文版
03 注释
确保它们看起来非常直接:使用正确的拼写,标点,以及语句结构,将较长的行进行折叠,等等。 在程序包里面,任何直接位于顶层声明之前的注释,都会作为该声明的文档注释。
程序中每一个被导出的(大写的)名字,都应该有一个文档注释。 文档注释作为完整的语句可以工作的最好,可以允许各种自动化的展现。第一条语句应该为一条概括语句,并且使用被声明的名字作为开头。
// Compile parses a regular expression and returns, if successful, a Regexp //
原书定位详情
来源:a19c7933-4eda-4176-aebd-30fe7e1ad292
正文位置:extracted/Effective Go中文版/_epub-src/OEBPS/注释.md.html
EPUB SHA-256:0fe00b742c425a3cbfb1dcf5db8f9ab889cfbd7ca3a4e3be39bba5876b63c1c7