godoc 技巧与注意事项

意义 文档对于代码的意义不用多说。在golang bolg中已经给出了详细的描述http://blog.golang.org/godoc-documenting-go-code。 我在实战中踩到了不少坑，这里给出更详细的解释以及注意事项。 我们针对golang源码中的注释进行分析得到如下结果。 针对Package的文档 Synopsis 参考http://golang.org/pkg/中的Synopsis。这句话主要出现在针对Package注释中的开头位置。 OverView 参考http://golang.org/pkg/archive/tar/。是针对Package中的注释出现的。如果出现连接，无需标注，生成文档的时候自动会处理成连接 参考例子与注意事项 包：

2015-07-11 10:03     Philo