【转】godoc介绍以及Golang注释规范.pdfVIP

【转】godoc介绍以及Golang注释规范 Golang 的⽂档从⼀开始发布就很完善了，但是很多⽤法我⼀直也么搞明⽩，今天详细研究了下，整理出来。 命令 golang 官⽅有有⽂档⾃动⽣成⽹站，地址是 ，⽐如：logger 的，godoc也可以在本地启动： godoc -http=:6060 启动之后浏览器访问 localhost:6060，就能看到⽂档⾸页了。如果想看⾃⼰代码的⽂档，后⾯输⼊包的路径即可，⽐如： http://localhost:6060/pkg//mnhkahn/gogogo/ 代码或者注释⽂档的修改可以实时更新，不需要重启服务。 代码中注释⽣成⽂档 godoc⽀持package、const、var和func这些代码⽣成⽂档，⽽且只会对public变量(⾸字母⼤写)⾃动⽣成，⽽private变量则不会。 Package 对包介绍的内容⽤的就是包名上⾯的注释 在⾃动⽣成的时候，⽐如说对于包， （变量和函数同理）。如果是多个包，就会把多个包的注释放 在⼀起，按照⽂件名字母顺序排序。