golang注释和文档说明及go doc/godoc说明

欢迎关注个人公众号 DailyJobOps

这里提前祝大家 2022新年快乐~
原文连接 golang注释和文档说明及go doc/godoc说明


golang注释

  • 单行注释

是最常见和使用的注释方式,以 // 开头,其后面的内容都是注释。

可以是单独的一行,也可以是在某个语句的后面。

比如:

package main

// 导入我们需要包,而且只导入需要的,多余导入会引起编译错误
import (
    "fmt"  // 这里也是单行注释,跟在某个语句的后面
)
  • 多行注释

不常使用,一般用来做代码块的注释 或者是 包的文档型描述, 文档型描述需要尽可能详细说明包及其对外暴露的函数等,有时候单行注释使用不方便

比如:

package convert

import (
    "strconv"
)

/*
 * 这里是多行注释,进行自定义包中对外函数的详细描述
 * 描述可以尽可能详细,让大家能读懂其作用是什么
 */

func Convert(name string) (string) {
    ... ...
}

golang 文档描述

在进行项目开发的时候,代码的注释是必不可少的,但是对于go来说,自定义包及其包中对外暴露的函数,添加额外的特殊说明,方便使用者快速了解使用。

这种特殊的说明就是文档描述,书写有要求规范

  • 包描述

    一般是在紧挨着 package 关键字上面一行,描述以 Package 开头,比如

    // Package convert is ...
    package convert
    
  • 函数描述

    函数描述是在func SomeName() 的紧挨着上面一行, 一般建议以 Function 开头,比如

    
    // Function SomeName is uesd to ...
    func SomeName() {
        ... ...
    }
    

go doc 工具

go doc 命令是基于go命令的。主要的作用是打印出go程序的文档信息,就是我们上面的所讲的文档描述。

通过 go help sub-command 可以查看具体命令的用法,比如这里的go help doc

在实际使用中,不清楚第三方如何使用的时候,go doc 就非常有用,比如字符串转浮点型,

  • go doc strconv

    直接后面跟 包 名称,可以查看包中都有哪些对外暴露的方法、变量等

  • go doc strconv ParseFloat

    后面跟 包名 加 对应的方法名、变量名等,可以查看具体的说明和用法

    # go doc strconv ParseFloat
    package strconv // import "strconv"
    
    func ParseFloat(s string, bitSize int) (float64, error)
        ParseFloat converts the string s to a floating-point number with the
        precision specified by bitSize: 32 for float32, or 64 for float64. When
        bitSize=32, the result still has type float64, but it will be convertible to
        ... ...
    

    再比如(注意使用 package.method 或者 package method 都可以)

    # go doc fmt.Sprintf
    package fmt // import "fmt"
    
    func Sprintf(format string, a ...interface{}) string
        Sprintf formats according to a format specifier and returns the resulting
        string.
    
  • go doc 后面不添加任何参数

    会打印当前目录所代表的代码包的文档及当中的包级别程序实体的列表

go doc 参数说明

  • -c 区分参数中字母的大小写
  • -u 同时会打印出 不可导出 的程序实体,默认只打印 可导出 实体 (golang的能否被其他包调用的原则就是可导出 ,首字母大写)
  • -cmd 同时打印出main包中的可导出的程序实体
  • -short 没有实体文档用一行标识

godoc 和 go doc 傻傻分不清楚

godoc 和 go doc 很像,但是不一样哦~

  • go doc是go的子命令,用于在命令行输出相关实体的文档说明

  • godoc 是通过在本地启动一个web程序,通过浏览器来展示本地相关包的文档信息,类似golang的在线文档

  • godoc默认是没有安装的,可以通过如下命令进行安装,默认是安装到GOBIN 环境变量定义的目录中

go get -v -u golang.org/x/tools/cmd/godoc

启动本地web访问在线文档的方式

godoc -http=:8080

然后在浏览器输入 http://localhost:8080 即可查看

godoc http.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 155,770评论 4 358
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,116评论 1 286
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 105,656评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,372评论 0 201
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,704评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,166评论 1 204
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,535评论 2 306
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,259评论 0 193
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,882评论 1 236
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,218评论 2 239
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,760评论 1 255
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,126评论 2 249
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,667评论 3 228
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,935评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,644评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,171评论 2 265
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,119评论 2 258

推荐阅读更多精彩内容

  • 2021-10-26注释用于对一些代码的解释,对初学Go代码或者其他语言很友好,对代码后期的维护更新也很方便。 跟...
    DepartBoy阅读 810评论 0 2
  • 目录 统一规范篇 命名篇 开发篇 优化篇 统一规范篇 本篇主要描述了公司内部同事都必须遵守的一些开发规矩,如统一开...
    零一间阅读 1,845评论 0 2
  • 原文:https://makeoptim.com/golang/standards/code-review-com...
    CatchZeng阅读 903评论 0 1
  • Golang作为一门新的编程语言,它借鉴了现有语言的思想但拥有着不同寻常的特性,使得有效的Go程序在性质上不同于其...
    云时代的运维开发阅读 830评论 0 0
  • 主要来源:《Go Web编程》 1、go build 作用:compile packages and depend...
    molscar阅读 318评论 0 0