go语言注释

Go语言注释实例代码教程 – Go帮忙C语言风格的/*
*/块注释,也帮忙C++风格的//行注释。
当然,行注释更通用,块注释首要用于针对包的详细表明只怕屏蔽大块的代码。

种种包都应有叁个包申明,即 package
前的块申明。对几个文本的包,包表明只需出现在多少个文本中,随便哪个。包申明应该介绍此包,并视作三个完全提供此包的对应新闻。它首先出现在
godoc 页面,来安插好持续的事无巨细文书档案。

图片 1

包要是简单,注释能够回顾。

图片 2

注脚不需多余排版如星星横幅等。生成的结果呈现时可能不是等宽字体,所以不用靠空格对齐,
godoc,类似 gofmt 照管那一个。最终,表明是不加解释的公文,HTML和其余诸如
_this_ 会原样照搬,所以应 制止使用。

在包里,紧跟顶层注解前的评释作为此表明的文申明,程序中各个导出(大写)的名字都应有有文注解。

文表明最好是完全的语句。首句应该以宣称的名字初叶的一句话的下结论。

图片 3

Go
的宣示句法允许编组。单1的文注明能够引出1组相联的常量或变量。因为整组声美赞臣(Meadjohnson)(Aptamil)起彰显,注明可以很不难:

图片 4

图片 5

对此个人名称,编组也得以指出它们中间的联络,例如1多元的变量由二个排斥保护。

 var (
      countLock   sync.Mutex
      inputCount  uint32
      outputCount uint32
      errorCount  uint32

)