第10章,部分字词修订。

This commit is contained in:
zhliner
2017-08-24 22:30:56 +08:00
parent c8ef4d39ea
commit dd3d261a3e
6 changed files with 9 additions and 9 deletions

View File

@@ -10,7 +10,7 @@ Go语言中的文档注释一般是完整的句子第一行通常是摘要说
func Fprintf(w io.Writer, format string, a ...interface{}) (int, error)
```
Fprintf函数格式化的细节在fmt包文档中描述。如果注释后跟着包声明语句那注释对应整个包的文档。包文档对应的注释只能有一个译注其实可以有多个它们会组合成一个包文档注释包注释可以出现在任何一个源文件中。如果包的注释内容比较长一般会放到一个独立的源文件中fmt包注释就有300行之多。这个专门用于保存包文档的源文件通常叫doc.go。
Fprintf函数格式化的细节在fmt包文档中描述。如果注释后跟着包声明语句那注释对应整个包的文档。包文档对应的注释只能有一个译注其实可以有多个它们会组合成一个包文档注释包注释可以出现在任何一个源文件中。如果包的注释内容比较长一般会放到一个独立的源文件中fmt包注释就有300行之多。这个专门用于保存包文档的源文件通常叫doc.go。
好的文档并不需要面面俱到文档本身应该是简洁但不可忽略的。事实上Go语言的风格更喜欢简洁的文档并且文档也是需要像代码一样维护的。对于一组声明语句可以用一个精炼的句子描述如果是显而易见的功能则并不需要注释。