标签:关键字 默认 cst 函数 pytho 简单 命令行 工具 str
Godoc是go语言的文档化工具,类似于文档化工具godoc,类似于Python的Docstring和Java的Javadoc
Godoc通过解析包含注释的Go代码来生成HTML或文本类型的文档。
godoc
Go的注释规则很简单,为类型,变量,常量,函数或包编写注释时,直接在这些声明前编写普通形式的注释,中间不留空行即可。Godoc将这些注释与后面的声明连接到一起,达到文档化的目的。
// 这是一行注释
package main
// 不会被识别
// 会被识别
package main
// 不会被识别
// 会被识别1
// 会被识别2
func main(){
}
godoc的输出将忽略那些与顶层声明不相邻的注释,只有一个例外,那就是以BUG(who)开头的注释。这些注释将被识别为已知的bug,并包含在文档的BUGS区。
// 注释
package main
// BUG(who) //会被识别,放入文档的Bugs区
const a = 8
首先在命令行进入所需要执行的.go文档目录
例:我的test.go放在C:/GoProject/src/test/ 目录下
需要在命令行进入C:/GoProject/src/test/
然后执行命令
godoc -http=:6060 //6060是godoc提供的默认端口
在浏览器输入 localhost:6060
,即可进入godoc的网站,查看自己的文档需要在地址栏输入路径 localhost:6060/pkg/test
标签:关键字 默认 cst 函数 pytho 简单 命令行 工具 str
原文地址:https://www.cnblogs.com/niuben/p/12387357.html