前言
最开始写 GO 的时候, 发现方法的注释并不支持@param, @return等参数, 搞得我都不知道该如何给自己的方法写文档说明了. 而且网上搜了搜也没有搜到教程, 甚是郁闷....image-20200719145327838
既然人家官方代码能生成文档, 那就说明是有文档生成格式的呀. 既然我不知道如何写文档, 抄官方的样式不就行了么? nice....文档关键字
那 GO 的注释中有没有文档用到的关键字呢? 有, 简单写几个....image-20200719161655341
Deprecated
已弃用的标识, 这个关键字看的太多了, 不过godoc并不会识别这个关键字, 主要是编译器识别.
// Deprecated: 请使用...DocDemoNew 方法
注意
文档注释与对应内容之间不能有空行.
godoc只会对公共内容生成文档, 私有内容不会展示.
----
GO的文档还有更多, 这里只是简单的整理一下, 对于之后写项目基本够用了