1 Go语言基础
1.1 语法详解
1.1.1 注释
/* regexp 包为正则表达式实现了一个简单的库。 该库接受的正则表达式语法为: 正则表达式: 串联 { '|' 串联 } 串联: { 闭包 } 闭包: 条目 [ '*' | '+' | '?' ] 条目: '^' '$' '.' 字符 '[' [ '^' ] 字符遍历 ']' '(' 正则表达式 ')' */ package regexp
godoc既是一个程序,又是一个web应用,它对GO的源代码进行处理,并提取包中的文档内容,出现在顶级声明之前,且与该声明之间没有空行的注释,将于该声明一起被提取出来,作为该条目的说明文档,这些注释类型和风格决定了godoc生成的文档质量。
每个包都应该包含一段包注释,既放置在包子句前的一个块注释,对于包含多个文件的包,包注释只需要出现在其中的任一个文件中即可,包注释应该整体上对该包进行介绍,并提供包的相关信息,它将出现在godoc页面中的最上面,并为紧随其后的内容建立详细的文档。若某个包比较简单,包的注释同样可以简介。