Godoc 安装与使用

Godoc 安装与使用

前言

笔者最近有一项开发程序包的任务需要完成，程序包设计好后还需要自动生成 API 文档，这就需要使用到 godoc 命令，由于生成的过程走过许多弯路，所以在此记录一下

Godoc 简介

命令 godoc 是一个很强大的工具，用于展示指定代码包的文档。如果我们的代码包在网上开源的话，别人使用我们的代码包，就可以通过查看 API 文档来快速了解代码包的使用方法。

安装过程

本人在 Windows 和 MAC OS 环境下都进行了安装，两者略有不同，在下面分别记录：

• Windows ：直接按照我下方的命令执行，就可以在目录的 bin 文件夹生成 godoc 可执行文件

  mkdir -p $GOPATH/src/golang.org/x
  cd $GOPATH/src/golang.org/x
  git clone https://github.com/golang/tools.git
  cd tools/cmd/
  go install ...
  

• MAC OS：如果大家有翻墙软件的话，下载的方式比较简单，直接执行下面的命令：go get -v -u golang.org/x/tools/cmd/godoc，执行完毕后到 bin 文件夹中进行查看ÿ