java也可以生成文档, 就像一个手册一样, 可以用来查看方法, 接口, 下面我们给go项目生成文档
godoc -http :6060
godoc如果没有需要下载
然后在浏览器打开http://localhost:6060就可以查看生成的文档了. 可以进入到Package包中查看.
1. 生成注释代码. 可以在文档中显示出来
2. 可以写示例代码, 最终也可以显示在文档中
a. 文件名命名方式和测试文件一样
b. 方法名以Example.......开头
c. 以注释的方式定义输出OutPut.
定义了Output预计输出的内容以后, 就可以想单元测试一样运行了. 会告诉你test 成功还是失败.
写好的示例代码, 也可以在文档中显示. 包括应该输出的返回值