go语言注释

Go语言注释实例代码教程 – Go支持C语言风格的/*
*/片注释,也支持C++风格的//行注释。
当然,行注释更通用,块注释主要用来对包的详细说明要屏蔽大块的代码。

每个包都应有一个保险注解,即 package
前之丘注解。对几近只公文的包,包注解只待出现在一个文本被,随便谁。包注解应该介绍此包,并作一个完好无损提供此包的附和信息。它首先出现于
godoc 页面,来布局好累的详实文档。

图片 1

管要简单,注释可以略。

图片 2

注解不待多余排版如鲜横幅等。生成的结果表现时或者无是等极富字体,所以不要因空格对同,
godoc,类似 gofmt 照管这些。最后,注解是免加以说的公文,HTML和其他如
_this_ 会原样照搬,所以应 避免用。

当担保里,紧跟顶层声明前之诠释作为这个声明的文注解,程序中每个导出(大写)的讳还应该生出温和注解。

文注解最好是完好的句子。首句应该因为宣称的名起的等同句子话的总。

图片 3

Go
的扬言句法允许编组。单一的文注解可以引出一组连的常量或变量。因为整组声明并展现,注解可以很简单:

图片 4

图片 5

于个体名称,编组为得指出它中的维系,例如一多元之变量由一个排斥保护。

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

)