golang学习之生成代码文档

摘要:
godoc工具将从Go程序和包文件中提取顶层声明的第一行注释和每个对象的相关注释,并生成相关文档。一般用法:godocpackage获取包的文档注释,godocpackage/subpackage获取子包的文档评论,godocpackagefunction获取包中函数的文档注释以及godocfmtPrintf显示使用fmt的说明。Printf()。

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 后,你就可以看到本地文档浏览服务器提供的页面。

免责声明:文章转载自《golang学习之生成代码文档》仅用于学习参考。如对内容有疑问,请及时联系本站处理。

上篇Linux下Wi-Fi的实现:wireless_tools和wpa_supplicantAndroid 修改屏幕亮度方案下篇

宿迁高防,2C2G15M,22元/月;香港BGP,2C5G5M,25元/月 雨云优惠码:MjYwNzM=

相关文章

MyEclipse 免安装版制作

前言:以MyEclipse6.0为例,安装目录,例如如d:javaMyEclipse6.0 (1)新建MyEclipse 6.0.bat文件 新建位置:当前MyEclipse根目录 文件内容:start eclipseeclipse.exe -vm jreinjavaw.exe (2)修改Eclipse 插件的配置文件com.genuitec.ecli...

#pragma comment

pragma 预处理指令具体解释 2008-05-21 11:00 pragma指令简单介绍 在编敲代码的时候,我们常常要用到#pragma指令来设定编译器的状态或者是指示编译器完毕一些特定的动作. 以下介绍了一下该指令的一些经常使用參数,希望对大家有所帮助! 一. message 參数。 message 它可以在编译信息输出窗 口中输出对应的信息,这对于...

JS-DOM样式操作

js样式操作 行内式样式操作 //行内式属性的获取 let value = 元素对象.style.属性名; //得到的值为String类型,如果要做算术运算需要转型 //仅能得到行内式属性的值,对于嵌入式、外联式的值无法获取 //属性名需要注意如果在css中唯一个单词则是原单词,如果在css中为多个单词则遵守驼峰命名法...

winform 对话框、打印框

winform 对话框控件 1、打开文件对话框(OpenFileDialog)  2、保存文件对话框(SaveFileDialog)  3、字体对话框(FontDialog)  4、颜色对话框(ColorDialog) 5、打开文件夹对话框 FolderBrowserDialog public Form1() {...

js的原型链

开篇 之前对js中的原型链和原型对象有所了解,每当别人问我什么是原型链和原型对象时,我总是用很官方(其实自己不懂)的解释去描述。有一句话说的好:如果你不能把一个很复杂的东西用最简单的话语描述出来,那就说明你没有真正的理解。最近正在读《Javascript高级程序设计》,书中对原型对象和原型链的描述让我受益匪浅,下面仅用一个对比性的例子来说明。 我们经常会这...

高性能JSON框架之FastJson的简单使用

转载 高性能JSON框架之FastJson的简单使用 1.前言1.1.FastJson的介绍:JSON协议使用方便,越来越流行,JSON的处理器有很多,这里我介绍一下FastJson,FastJson是阿里的开源框架,被不少企业使用,是一个极其优秀的Json框架,Github地址: FastJson 1.2.FastJson的特点:1.FastJson数度...