golang除了语言有一定的规范外,对于文档的生成也是非常不错的。仅仅要按go的格式来写的程序,都能够非常easy的生成文档。

godoc命令介绍:

http://golang.org/cmd/godoc/

godoc blog(英文:

http://blog.golang.org/2011/03/godoc-documenting-go-code.html

遵守几个规则:

 凝视须要紧贴相应的包声明和函数之前,不能有空行。

 假设凝视内要有空行。应该使用空白凝视行。

 开发人员能够直接使用//BUG(author):的方式记录该代码片段中的遗留问题。

实际操作样例:

最经常使用的:

 godoc –http=”:8080”

 这样就打开了跟golang.org一样的站点,假设不能訪问golang.org的时候就能够这样訪问,并且建议一般平时就这样訪问速度更快。

 并且pkg里面会有全部安装过的包。如:原来 go get labix.org/v2/mgo 就会有mgo的包 或者go install 到$GOROOT/src/pkg中也是能够查看到的。

终端下使用:

 godoc fmt Println

 就是打印fmt.Println这个函数的用法,假设习惯在终端命令行下能够如此使用

查看外部的包:

godoc -http=”:8080” -path=”.”

由于godoc默认是去$GOROOT/src/pkg读取的,假设有project不在这个以下的。我们能够使用path

 这有几个注意的问题:

  1.假设使用. pkg里面仅仅会有这个包的文档,不会有原来go自带的。

使用绝对路径才会都有。

2.path不能以/ 结尾不然会报错invalid -path argument: “/root/go/” has no final element

3.文档显示是以path最后一个文件夹为包名。如文件夹结构为 project/src/todolist 假设path指到project 这一层 包的显示是 project src todolist 三层 假设指向src 就是src todolist 两层 仅仅是显示的问题不影响使用,只是看着比較的别扭。好像没有太好的办法

  4.全部上面的这些參数假设观察细致会发现有的是–两杠和-一杠,两种方法都是能够接受的。

http://www.ohlinux.com/archives/813/ shell python golang 參数传递的对照。


转载自http://bbs.studygolang.com/thread-91-1-1.html

godoc工具使用的更多相关文章

  1. 搭建emacs的go编程语言环境

    关于emacs就不说明了,直接切入主题.关于我的emacs配置,可以直接参考GitHub上的lienhua34/myemacs-conf. go-mode 安装 关于go-mode的安装,可以直接参考 ...

  2. 组织Golang代码

    本月初golang官方blog(需要自己搭梯子)上发布了一篇文章,简要介绍了近几个月Go在一 些技术会议上(比如Google I/O.Gopher SummerFest等)的主题分享并伴有slide链 ...

  3. [dev] Go语言查看doc与生成API doc

    类似与javadoc,go也可以自动生成doc文档. 方法有两个: 1. 使用go doc工具 可以查看它的详细文档: go help doc 示例: 在这个目录下,我创建一个api包 ╰─>$ ...

  4. Go语言代码规范指导

    本规范旨在为日常Go项目开发提供一个代码的规范指导,方便团队形成一个统一的代码风格,提高代码的可读性,规范性和统一性.本规范将从命名规范,注释规范,代码风格和 Go 语言提供的常用的工具这几个方面做一 ...

  5. GO语言的进阶之路-go的程序结构以及包简介

    GO语言的进阶之路-go的程序结构以及包简介 作者:尹正杰 版权声明:原创作品,谢绝转载!否则将追究法律责任. 一.编辑,编译和运行 A,编辑 Go程序使用UTF-8编码的纯Unicode文本编写.大 ...

  6. Go语言环境安装详细介绍

    工具链介绍 go有两套编译工具链,分别是从plant9移植过来的gc和依赖gcc的gccgo. 官方为gc工具链提供了二进制安装包和源码, 可以根据需要选择一种安装方式.gc工具链对操作系统和CPU类 ...

  7. 02. Go 语言基本语法

    Go语言基本语法 变量.数据类型和常量是编程中最常见,也是很好理解的概念.本章将从 Go 语言的变量开始,逐步介绍各种数据类型及常量. Go 语言在很多特性上和C语言非常相近.如果读者有C语言基础,那 ...

  8. 《Go语言实战》读书笔记

    <Go语言实战>中文版pdf 百度网盘: https://pan.baidu.com/s/1kr-gMzaPAn8BFZG0P24Oiw 提取码: r6rt 书籍源码:https://gi ...

  9. 【Go命令教程】6. go doc 与 godoc

    go doc 命令可以打印附于Go语言程序 实体 上的文档.我们可以通过把程序实体的标识符作为该命令的参数来达到查看其文档的目的. 插播:所谓 Go语言的 程序实体,是指变量.常量.函数.结构体以及接 ...

随机推荐

  1. [XJOI]noip40 T2统计方案

    统计方案 小B写了一个程序,随机生成了n个正整数,分别是a[1]..a[n],他取出了其中一些数,并把它们乘起来之后模p,得到了余数c.但是没过多久,小B就忘记他选了哪些数,他想把所有可能的取数方案都 ...

  2. 关于api接口文档RAP和swagger

    前言: 在之前的项目中用了将近一年的RAP,RAP是由阿里开源出来的,非常好用.github地址:https://github.com/thx/RAP. 当初在用此工具时,项目成员需要在接口文档在所改 ...

  3. Solr.NET快速入门(四)【相似查询,拼写检查】

    相似查询 此功能会返回原始查询结果中返回的每个文档的类似文档列表. 参数通过QueryOptions的MoreLikeThis属性定义. 示例:搜索"apache",为结果中的每个 ...

  4. 破解VIP会员视频集合

    浏览器安装暴力猴扩展即可使用 // ==UserScript== // @name 破解VIP会员视频集合 // @namespace https://greasyfork.org/zh-CN/use ...

  5. GoogleMap 获取自己的数字证书API key的步骤

    http://dreamylights.blog.51cto.com/1163218/1360759 1. 进入到Google APIs Console页面 https://code.google.c ...

  6. Java数组操作工具

    原文地址:http://blog.csdn.net/qq446282412/article/details/8913690 2013-05-11 10:27   看到网上的一段关于对数组操作的代码,觉 ...

  7. Goldengate升级之目标端(replicat端)升级

    转自红黑联盟Goldengate升级之目标端(replicat端升级 要升级replicat端的原因为:目标端OGG软件版本与源端OGG软件版本不同,在实际生产应用中,经常发现replicat端事务丢 ...

  8. outlook导入配置文件

    公司入.离职人员越来越多,所以产生了一个自动化配置邮件的想法 查看了一下资料,outlook有导入配置文件的方法可用. 利用otc工具,打开office2010的安装文件夹,执行setup.exe / ...

  9. ubuntu下安装 nginx + php + memcached + mariadb

    一,apt-get 安装 1,安装nginx sudo apt-get install nginx 所有的配置文件都在/etc/nginx下,虚拟主机配置在/etc/nginx/sites-avail ...

  10. mysql 每个月创建新表

    1.CREATE DEFINER=`root`@`%` PROCEDURE `aa`()BEGIN SET @sqlstr = CONCAT('create table cdrpbx10_',DATE ...