关于golang如何生成文档

go语言自带的文档生成十分好用

下面我们来看看具体怎么操作

我们先来看一个没有任何注释的一个先进先出的队列例子

package queuetype Queue []interface{}func (p *Queue) Push(v interface{}){*p = append(*p,v.(int))
}
func (p *Queue) Pop() interface{}{head := (*p)[0]*p = (*p)[1:]return head
}
func (p *Queue) IsEmpty() bool{return len(*p) == 0
}

接下来我们打开powershell（cmd或者linux，mac都可以）输入go doc

这样我们就打开了系统自带的文档一般情况下我们都是使用ide查看文档这个只是作为了解使用

不过命令行有一个godoc -http :6060非常好用我们可以使用 godoc -help打开godoc帮助文件里面有详细介绍

就这样我们打开了golang的本地文档

接着我们去寻找开头的queue包文档

这里我们结合开头代码可以看到没有显示任何文档

下面我们给它添加一下注释

package queue
// An FIFO queue.
type Queue []interface{}
// Pushes the element into the queue.
func (p *Queue) Push(v interface{}){*p = append(*p,v.(int))
}
//Pops element from head.
func (p *Queue) Pop() interface{}{head := (*p)[0]*p = (*p)[1:]return head
}
// Returns if the queue is empty or not.
func (p *Queue) IsEmpty() bool{return len(*p) == 0
}

添加完后我们先用命令行查看一下

注释出来了接着我们重启一下6060端口刷新网页

文档成功显示

在go语言中文档的书写是很舒服的没有特别的框框架架

go语言在写注释时// .......文字描述之前多加几个空格 go语言的本地文档会给我们自动加框如下图

除此之外 go语言还提供了一种特殊的文档编写方法

我们按照测试方法在同一包内创建queue_test.go文件

是不是发现这明明就是测试文件创建方法

没错 _test.go文件既可以当做测试文件也可以当做文档生成文件做成文档需要输入关键字Exam

下面是文档生成的例子

package queueimport "fmt"func ExampleQueue_Pop() {q := Queue{1}q.Push(2)q.Push(3)fmt.Println(q.Pop())fmt.Println(q.Pop())fmt.Println(q.IsEmpty())fmt.Println(q.Pop())fmt.Println(q.IsEmpty())//  Output:// 这里我们先随便写 执行成功后会打印正确内容
}

执行后结果为注意go语言自动检查执行结果是否正确

package queueimport "fmt"func ExampleQueue_Pop() {q := Queue{1}q.Push(2)q.Push(3)fmt.Println(q.Pop())fmt.Println(q.Pop())fmt.Println(q.IsEmpty())fmt.Println(q.Pop())fmt.Println(q.IsEmpty())//  Output://    1// 2// false// 3// true
}

我们重启godoc -http ：6060

go语言的文档生成是不是很简单

总结一下go语言的文档特点

.用注释写文档

.在测试中加入Example

.使用go doc/godoc 来查看/生成文档

最后总结一下go语言整个测试

.表格驱动测试 go语言通过结构体来实现测试的主体这是语法本身支持的

.代码覆盖有覆盖率及覆盖率调试通过ide进行查看明确又清晰

.性能优化工具通过pprof打开图形可视化性能图依块的大小来调节性能

.http测试通过这个简单的例子从头到尾测试一遍包括代码执行结果覆盖率等

.文档及示例代码 go语言的示例代码输出结果也能进行失败

关于golang如何生成文档相关推荐

Objective-C自动生成文档工具:appledoc
作者 iOS_小松哥关注 2016.12.13 15:47* 字数 919 阅读 727评论 10喜欢 35 由于最近琐事比较多,所以好久没有写文章了.今天我们聊一聊Objective-C自动生成文 ...
Objective-C 自动生成文档工具:appledoc
来源:iOS_小松哥 www.jianshu.com/p/fd4d8d6b6177 如有好文章投稿,请点击 → 这里了解详情由于最近琐事比较多,所以好久没有写文章了.今天我们聊一聊Objective ...
java前端目录_[Java教程]前端那点事儿——Tocify自动生成文档目录
[Java教程]前端那点事儿--Tocify自动生成文档目录 0 2016-06-29 22:00:07 今天偶然间看到文档服务器有一个动态目录功能,点击目录能跳转到指定的位置:窗口滑动也能自动更新目 ...
快速优雅的为React组件生成文档
在开发React组件时我们通常需要处理2个问题: 实例化这个组件以便调试为这个组件编写使用文档以便更好的让别人知道怎么使用这个组件最原始的方法莫过于开发时建一个页面用于调试,开发完后再为其手写文档 ...
linux c/c++ 代码使用 doxygen 自动生成文档
www.doxygen.org 的使用非常方便,下面分成2步介绍一下 1. 注释风格,需要在c/c++代码中按照下面的风格添加注释,基本上还是很顺手的 C++的注释风格主要使用下面这种样式:即在注释 ...
使用DocFX生成文档
使用DocFX命令行生成文档使用docfx 命令 1.下载 https://github.com/dotnet/docfx/releases 2.使用创建初始项目 docfx init -q 此命 ...
docwizard c++程序文档自动生成工具_如何开发一个基于 TypeScript 的工具库并自动生成文档
为什么用 TypeScript? TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. Any ...
使用javadoc命令生成文档
可以使用命令 javadoc *.java 生成文档
配置WCF同时支持WSDL和REST，swaggerwcf生成文档
配置WCF同时支持WSDL和REST,SwaggerWCF生成文档 VS创建一个WCF工程,通过NuGet添加SwaggerWcf 创建完成后通过程序包管理控制台 pm>Install-Pac ...
使用eclipse生成文档（javadoc）
作者:xyz 使用eclipse生成文档(javadoc) 使用eclipse生成文档(javadoc)主要有三种方法: 1,在项目列表中按右键,选择Export(导出),然后在Export(导出)对 ...

关于golang如何生成文档

关于golang如何生成文档相关推荐

最新文章

热门文章