文档章节

golang学习之生成代码文档

c
 caiyezi
发布于 2016/11/08 20:23
字数 187
阅读 83
收藏 0

go doc 工具会从 Go 程序和包文件中提取顶级声明的首行注释以及每个对象的相关注释,并生成相关文档。

一般用法:

  • go doc package 获取包的文档注释,例如:go doc fmt 会显示使用 godoc 生成的 fmt 包的文档注释。
  • go doc package/subpackage 获取子包的文档注释,例如:go doc container/list
  • go doc package function 获取某个函数在某个包中的文档注释,例如:go doc fmt Printf 会显示有关 fmt.Printf() 的使用说明。

在命令行输入 godoc -http=:6060,然后使用浏览器打开 http://localhost:6060 后,你就可以看到本地文档浏览服务器提供的页面。

本文转载自:http://www.cnblogs.com/vipzhou/p/5579515.html

c
粉丝 1
博文 108
码字总数 0
作品 0
西安
程序员
私信 提问
如何维护一个自己的 golang doc 服务

本文内容是如何维护一个golang 在线的doc 服务。 1 什么是godoc ? godoc 是 golang 官方提供的文档生成工具, 2 为什么要有godoc ? 我们经常遇到一个问题,就是代码和文档不一致,线上代码版...

鼎铭
01/16
385
0
GoHub 更新至 0.6,在线 Golang 文档阅读

GoHub 更新至 0.6,基于 Github REST API v3 的 Golang 在线文档。 GoHub WIP (尚在开发中...) GoHub 使用 Github REST API v3 提供在线 Golang 文档阅读. 便捷的文档项目组织 Go Doc API 翻...

喻恒春
2018/05/21
1K
0
golang入门学习笔记(四)

作者: 一字马胡 转载标志 【2017-11-25】 更新日志 日期 更新内容 备注 2017-11-25 新建文章 go语言入门学习笔记(四) golang入门学习笔记系列 golang入门学习笔记(一) golang入门学习笔...

一字马胡
2017/11/25
0
0
用golang重写SS帐号获取脚本

Golang有个很酷的特性可以跨平台编译生成该平台的二进制可执行文件,虽然python也能通过其他工具生成相应平台的二进制文件,但是还是觉得太别扭了,通过golang写一次,然后生成相应平台的二进...

youerning
2018/06/29
0
0
golang 入门

golang http://golang.org/ Go语言是由Google开发的一个开源项目,具体语言特征就不细说了,可以查看一下文档。 学习使用了几天,想起了一句广告语: 简约而不简单。 资深程序员 云风对go语言...

xsong
2011/12/19
2.5K
1

没有更多内容

加载失败,请刷新页面

加载更多

mybatis 的xml,Integer类型参数bug问题

当有Integer数据类型的参数值为0时,如pid=0,xml中pid=="" 判断为ture,即不走条件语句 <if test="pid != null and pid != '' "> AND a.pid = #{pid}</if> 所以还要加上一句 or pid==......

避难所
30分钟前
4
0
Sentinel 1.7.0 发布,支持 Envoy 集群流量控制

流控降级中间件 Sentinel 1.7.0 版本正式发布,引入了 Envoy 集群流量控制支持、properties 文件配置、Consul/Etcd/Spring Cloud Config 动态数据源适配等多项新特性与改进。详细特性列表请参...

阿里云官方博客
36分钟前
4
0
redis编写lua脚本实现商品秒杀

编写lua脚本 --是否秒杀local hasBuy = redis.call('sismember',KEYS[1],ARGV[1]) if hasBuy~=0 then return 0;end--校验库存for goodsIndex=2,#KEYS do local go......

嘴角轻扬30
38分钟前
3
0
com.hazelcast.spi.exception.RetryableHazelcastException:HazelcastInstance is not active!

使用 hazelcast 坑爹事情,错误日志如下 com.hazelcast.spi.exception.RetryableHazelcastException: HazelcastInstance is not active!at com.hazelcast.spi.impl.NodeEngineImpl.getSe......

糊说八道
39分钟前
4
0
好程序员Java教程分享Java面试妙招

  好程序员Java教程分享Java面试妙招,2019年,IT职位依然相当热门,特别是Java开发岗位。软件开发人才在今年将有大量的就业机会。不过,对于很多不善言辞的开发者而言,面试成了招聘过程中...

好程序员官网
45分钟前
6
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部