精华内容
下载资源
问答
  • godoc

    千次阅读 2017-11-19 16:24:38
    经使用发现,代码中的注释能第一时间反应在godoc中,但是package整体的介绍却不会,需要终止godoc程序,然后在重新运行,改变才会看到

    go语言可以在代码的注释中进行说明,格式正确的话就会被godoc展现出来

    经使用发现,代码中的注释能第一时间反应在godoc中,但是package整体的介绍却不会,需要终止godoc程序,然后在重新运行,改变才会看到

    还有,最好使用英文进行说明。英文的话,如果前一行和后一行都有空格,而且本行开头首字母大写,行尾还没有标点,那就会被当成标题显示

    一组前面有退格的说明会被godoc发现,并且放到灰色的框中,很好看

    展开全文
  • godoc-docker 在 Docker 中运行。 这个容器默认运行godoc -http=:6060 。 使用以下命令运行它: docker run -v $GOPATH:/gopath --net=host -d --name=godoc -p 6060:6060 arschles/docker-godoc
  • godoc技巧 本教程介绍了使godoc井井有条的技巧。 这是我收集的技巧的汇总,找不到完整的指南。 可以在以下位置找到该文档:
  • 打开godoc.org当前选定的页面。 Goto GoDoc允许您在godoc.org中打开当前打开的Go存储库以显示其文档。 大多数Go软件包都包含文档。 如果软件包提供了公共源代码存储库,例如在GitHub,BitBucket,Launchpad,Google ...
  • godoc-验证 验证代码中所有函数的简单 godoc 验证器具有 godoc 样式注释。 用法: $ godoc-validate github.com/name/project 示例输出: Analyzing template: [W] makeParameter() is missing godoc ...
  • Godoc for Golang,支持翻译。 下载中文翻译: git clone https://github.com/chai2010/golangdoc.translations.git $(GOROOT)/translations 启动中文Godoc服务器: go get github.com/Go-zh/godoc-i18n godoc-...
  • goclipse godoc.exe

    2018-04-24 12:47:42
    windows下用eclipse+goclipse插件 godoc.exe windows下用eclipse+goclipse插件 godoc.exe
  • godoc的使用

    千次阅读 2020-07-11 16:43:48
    GolangDoc: Could not find godoc, (hint: is godoc installed?) 本文将介绍如何使用godoc查看go语言文档。 安装godoc go get -v golang.org/x/tools/cmd/godoc 启动Go Documentation Server godoc -http=:6060 ...

    如何在本地轻松查看go document?

    如何解决godoc无法找到的问题:

    GolangDoc: Could not find godoc, (hint: is godoc installed?)
    

    本文将介绍如何使用godoc查看go语言文档。

    安装godoc

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

    启动Go Documentation Server

    godoc -http=:6060
    

    在浏览器中,打开url
    http://localhost:6060

    go document就呈现出来。

    在这里插入图片描述

    很简单吧,你也可以试一下。

    如果因为被墙了,可以尝试下从github下载后编译

    参考

    How to make “godoc” command work on my system?

    展开全文
  • Wide GoDoc-crx插件

    2021-04-02 07:10:28
    语言:English 动态扩展GoDoc的宽度 动态扩展GoDoc和pkg.go.dev的宽度
  • Github Godoc-crx插件

    2021-04-02 03:23:55
    语言:English 增强Github UI for Go项目 此扩展程序修改了Go项目的Github文件列表视图:*用有用的godoc.org提要替换git commit消息。 *在godoc.org中添加带有链接的图标。
  • godoc教程learn_doc.zip

    2019-10-17 22:33:56
    godoc教程——这个自己goland 关于 godoc 的学习笔记,里面包含示例package注释文件,超详细
  • godoc工具使用

    万次阅读 2016-03-14 16:56:34
    godoc工具使用

    golang除了语言有一定的规范外,对于文档的生成也是非常不错的,只要按go的格式来写的程序,都可以很容易的生成文档。

    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使用方法介绍

    2019-10-22 18:04:06
    Godoc是go语言的文档化工具,类似于文档化工具godoc,类似于Python的Docstring和Java的Javadoc Godoc通过解析包含注释的Go代码来生成HTML或文本类型的文档。 二、约定规则 godoc Go的注释规则很简单,为类型,变量,...

    一、go doc简介

    Godoc是go语言的文档化工具,类似于文档化工具godoc,类似于Python的Docstring和Java的Javadoc
    Godoc通过解析包含注释的Go代码来生成HTML或文本类型的文档。

    二、约定规则

    godoc
    Go的注释规则很简单,为类型,变量,常量,函数或包编写注释时,直接在这些声明前编写普通形式的注释,中间不留空行即可。Godoc将这些注释与后面的声明连接到一起,达到文档化的目的。

    1.注释符// 后加空格
    // 这是一行注释
    package main
    
    2.注释紧邻关键字行写,否则不会被识别
    // 不会被识别
    
    // 会被识别
    package main
    
    // 不会被识别
    
    // 会被识别1
    // 会被识别2
    func main(){
    
    	}
    
    3.注释行的数量最好不要超过3行
    4.已知bug注释:BUG(who)

    godoc的输出将忽略那些与顶层声明不相邻的注释,只有一个例外,那就是以BUG(who)开头的注释。这些注释将被识别为已知的bug,并包含在文档的BUGS区。

    // 注释
    package main
    
    
    // BUG(who)  //会被识别,放入文档的Bugs区
    
    
    const a = 8
    

    三、使用命令

    首先在命令行进入所需要执行的.go文档目录
    例:我的test.go放在C:/GoProject/src/test/ 目录下
    需要在命令行进入C:/GoProject/src/test/
    然后执行命令

     godoc -http=:6060     //6060是godoc提供的默认端口
    

    在浏览器输入 localhost:6060 ,即可进入godoc的网站,查看自己的文档需要在地址栏输入路径 localhost:6060/pkg/test

    展开全文
  • Godoc 安装与使用

    千次阅读 2020-10-19 15:59:54
    文章目录Godoc 安装与使用前言Godoc 简介安装过程GoDoc 使用说明 Godoc 安装与使用 前言 笔者最近有一项开发程序包的任务需要完成,程序包设计好后还需要自动生成 API 文档,这就需要使用到 godoc 命令,由于生成的...
  • Goto GoDoc-crx插件

    2021-04-02 02:22:31
    Goto GoDoc允许您在pkg.go.dev中打开当前打开的Go存储库以显示其文档。 大多数Go软件包都包含文档。 如果某个软件包提供了公共源代码存储库,例如在GitHub,BitBucket,Launchpad,Google Code上,甚至是自托管的,...
  • godoc web帮助文档

    2021-02-20 17:26:11
    godoc命令在我的系统上不起作用(我正在使用Linux Mint 20 Ulyana)。 我刚刚尝试了以下过程: 使用以下命令安装godoc: go get golang.org/x/tools/cmd/godoc 启动godoc服务器: godoc -http=:6060结果是:bash: ...
  • godoc 的安装使用

    2020-11-07 16:57:43
    go get -v golang.org/x/tools/cmd/godoc 常见的使用技巧 # 查看包内的文档,这里是查看 fmt 包中Println 的的文档 godoc fmt Println # 查看文档并包含源码 godoc -src fmt Printf # 显示文档的web版本 http ->...
  • godoc go语言版本的 showdoc
  • godoc使用详解

    千次阅读 2019-05-24 17:17:25
    例子:我想要生成某个文件夹下的go文档,假设你的gopath是D:/code你项目目录是D:\...第1步、那么在命令行中进入到该文件夹下 D:\code\src\test,执行 godoc -http=:6060 第2步、打开浏览器输入http://127.0.0.1:...
  • Godoc: documenting Go code编写良好的文档关于godoc 31 March 2011 The Go project takes documentation seriously. Documentation is a huge part of making software accessible and maintainable. Of course ...
  • godoc与go doc相关

    2020-10-08 17:32:33
    godoc与go doc相关 文章目录godoc与go doc相关环境Why godoc & go doc安装命令使用godocgo doc总结 环境 操作系统:Ubuntu18.04.5LTS-amd64 Why godoc & go doc 课程学习中只涉及文档与源代码中查询包,实际...
  • Go语言 godoc.exe下载。可以查看包的源码。直接解压到go目录下bin文件夹下即可,跟go和gofmt 并存。
  • Go——godoc命令简介

    2019-06-21 13:53:00
    godoc的一些简记 命令 godoc的列表 | godoc的chm下载 查看godoc的所有命令 `$ godoc -h` usage: godoc -http=localhost:6060 -analysis string comma-separated list of analyses to perform (supported: type, ...
  • 创建数据库(godoc-utf8mb4 / utf8mb4_general_ci)并导入godoc.sql 在env.ini.dev => env.ini文件中配置数据库信息 执行相应操作系统的并发症文件 访问: localhost:8000 log.xml.dev => log.xml为日志配置文件,...
  • 移动设备上的 Godoc
  • 您可以使用Ging在 GoDoc 中可用的每个包中进行查找。 现在只有一小部分包被索引,但每个人都可以向索引中添加一个包。 地点 现在Ging可以在上访问,但它是暂时的。 例子 Buffer。 DefaultClient。 websocket。 ...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 4,242
精华内容 1,696
关键字:

godoc