[go]go注释中的Example

意思就是说可以为代码写一个example_test.go文件，然后为函数起名：ExampleXXX，就是为XXX写的example，在看XXX函数注释的时候就会引用到这个example。

转载文件自：原文链接，建议看原文，本文为节选。

查看example_test.go的文件内容之后得出了以下结论：

如果为函数添加Example, 直接在example_test.go文件中添加函数func Example{要提供示例的函数名}

func ExampleDesEncrypt() {var data = "Hello World !"var goodkey = "abcd1234"security, err := DesEncrypt([]byte(data), []byte(goodkey))if err != nil {t.Error(err)}d, err := DesDecrypt(security, []byte(goodkey))if err != nil {log.Fatal(err)}if string(d) != data {log.Fatal(data, goodkey, string(security), string(d))} else {log.Println("Ok")}
}

如果为方法添加Example, 直接在example_test.go文件中添加函数func Example{方法接受者结构体类型名}_{要提供示例的方法名}

func ExampleCutImage_CutSrcImage() {var src = "src.png"var w, h = 100, 100for i := 20; i < 800; i += 100 {var cutIamge = CutImage{SrcImageFileName:   src,DestImageFileName:  "dest" + strconv.Itoa(i) + ".png",DestImageWidth:     w,DestImageHeight:    h,SrcImageStartPoint: image.Point{X: i, Y: i},}//裁剪图片err := cutIamge.CutSrcImage()if err != nil {log.Fatal(err)}}
}

如果为类型添加Example,直接在example_test.go文件中添加函数fun Example{类型名}

func ExampleCutImage() {var cutIamge = CutImage{SrcImageFileName:   "src.png",DestImageFileName:  "dest.png",DestImageWidth:     100,DestImageHeight:    100,SrcImageStartPoint: image.Point{X: 0, Y: 0},}_ := cutIamge.CutSrcImage()
}

如果添加Example的函数名，类型名，方法名不存在，将会在godoc抽取生成文档是忽略，如下：

2015/09/30 14:45:28 skipping example 'ExampleCutSrcImage' because 'CutSrcImage' is not a known function or type
2015/09/30 14:52:53 skipping example 'ExampleCutImage_CutSrcImage2' because 'CutImage_CutSrcImage2' is not a known function or type

[go]go注释中的Example相关推荐

3D U-Net：从稀疏注释中学习密集的体积分割
作者:Tom Hardy Date:2020-01-10 来源:3D U-Net:从稀疏注释中学习密集的体积分割
java中如何调用属性_java – 如何从属性文件导入值并在注释中使用它？
我有一个实体类: Class.java @Entity public class Class { @Id @GeneratedValue private Long id; @NotNull @Rang ...
java常量数组吗_java – 如何在注释中使用数组常量
我想为注释值使用常量. interface Client { @Retention(RUNTIME) @Target(METHOD) @interface SomeAnnotation { Strin ...
QT--在注释中遇到意外的文件结束
"在注释中遇到意外的文件结束"--记一个令人崩溃的bug 下午写程序,写的好好的,突然报错"在注释中遇到意外的文件结束". 下面是官方给出的错误原因是缺少注释终 ...
QT 在注释中遇到意外的文件结束
QT 在注释中遇到意外的文件结束解决: 这个与编码格式有关.可能各个不同的系统方法不一样.我的是win10, 64位,MSVC-2019,没问题: ![在这里插入图片描述](https://img- ...
Maker 注释中的小问题
Maker 注释中的小问题之前所里的老旧服务器上不支持mpi,于是只好在某宝上花钱租了一个20核心40线程的机器来跑maker, 好不容易把OPENMPI4.0.5软件全安装好,最后一步跑的时候,使 ...
java中的注释_Java注释中的/ **和/ *
小编典典第一种形式称为Javadoc.在为javadoc工具编写由程序生成的正式API时,可以使用此功能.例如,Java 7 API页面使用Javadoc并由该工具生成. 您将在Javadoc中看到 ...
idea java代码注释中@标签模板创建，apidoc接口文档@标签模板创建
我们在开发工具中的代码注释经常会用到一些@标签,比如常用的@author ,如下: 那么我们如果要自定义一些自己需要的注释标签模板呢,比如在使用 apidoc生成接口模板时,就需要经常写一些apido ...
MySQL注释中的sql也可能执行
MySql支持三种注释形式:# 和–属于单行注释,注释范围为该行的结尾:/* */注释属于多行注释,此外该种注释还可以实现行内注释.具体的使用情况如下图中所示(四种使用情形): 除此之外,/* */这 ...
java注释中添加删除线_如何在Word中添加和删除注释
java注释中添加删除线 Leaving comments in a Word document is a good way to leave feedback on a piece you're r ...

[go]go注释中的Example

[go]go注释中的Example相关推荐

最新文章

热门文章