godoc安装与自动生成API文档

最新推荐文章于 2023-02-21 11:46:15 发布
原创 最新推荐文章于 2023-02-21 11:46:15 发布 · 782 阅读 · 1 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

本文指导如何在Bash中设置环境变量轻松安装godoc，并通过http访问其文档，还演示了导出文档到html的方法。

先使用命令go get golang.org/x/tools/cmd/godoc来安装godoc。该命令会访问官网下载godoc，有可能访问超时。为此，需要在Bash下设置如下的环境变量：

export GOPROXY=https://goproxy.io
export GO111MODULE=on

这样就可以顺利安装godoc：
在这里插入图片描述
然后在bash下运行命令go build golang.org/x/tools/cmd/godoc
在这里插入图片描述

再运行godoc就可以在浏览器通过http://localhost:6060/来访问godoc了。
在这里插入图片描述
在这里插入图片描述

之后，还可以将文档导出出来：


                

                
                
        

    



  


        

            

                      
                        最低0.47元/天 解锁文章
                          
                      
            

        


    



                



	

		

			

				
					
Go 利用 godoc 自动生成 API 文档

				
			

			

				

					KianKwok的博客
				

				

					10-19
					
					1988
					
				

			

		

		

			
				
Go 利用 godoc 自动生成 API 文档
背景
在课程项目中需要完成 API 文档，自己写的文档不够规范且没有模版。后来了解到可以通过 godoc 自动生成 API 文档，十分方便。
环境说明
操作系统：Ubuntu 18.04.4 LTS (GNU/Linux 4.15.0-96-generic x86_64)
编辑器：vim
编译工具：go version go1.10.4 linux/amd64
过程

下载一个 go 项目作为实例。

go get github.com/go-ini/ini


			
		

	



                

            
              



	

		

			

				
					
Go 注释生成 api文档

					
最新发布

				
			

			

				

					arslan-robot
				

				

					05-15
					
					703
					
				

			

		

		

			
				
生成 API 文档，你需要遵循一些特定的注释格式。这些注释应该位于包声明、类型、变量、函数和方法之前，并且使用特定的注释块（即文档注释）。这样的工具来生成更丰富的 API 文档，但这通常需要额外的配置和注解。对于简单的 API 文档需求，是 Go 官方提供的文档生成工具，它可以解析 Go 源代码中的注释，并生成在线的、可交互的文档。下面是一个示例，展示了如何为 Go 代码中的函数和方法编写文档注释，以便。开头，紧接着是一个换行符，然后是注释内容。工具来从注释中生成 API 文档。另外，你也可以使用像。

			
		

	



              


  
              

                


	

		

			

				
					
Go godoc 自动生成 API 文档

				
			

			

				

					hllyzms的博客
				

				

					01-20
					
					1992
					
				

			

		

		

			
				
参考：Go 利用 godoc 自动生成 API 文档

https://blog.youkuaiyun.com/KianKwok/article/details/109166906



beego自动化文档

https://www.jianshu.com/p/0d375f4b36b2



Go——godoc命令简介

https://www.cnblogs.com/wangyang0210/p/11064128.html
...

			
		

	





	

		

			

				
					
如何写高大上的 godoc（Go 文档）

				
			

			

				

					QQ群166477105Python技术群
				

				

					02-05
					
					1669
					
				

			

		

		

			
				
godoc 命令和 golang 代码文档管理
https://www.jianshu.com/p/b9ce0cbaabd5
介绍

godoc 是 golang 自带的文档查看器，更多的提供部署服务
go doc 和 godoc 在 golang 1.13 被移除了，可以自行安装 golang.org go1.13 godoc

go get golang.org/x/tools/cmd/god...

			
		

	



		

			
		



	

		

			

				
					
godoc 查看开发者生成文档

				
			

			

				

					Allen
				

				

					08-19
					
					635
					
				

			

		

		

			
				
go 语言 godoc 查看开发者生成文档

			
		

	





	

		

			

				
					
Golang  1.0 文档使用。godoc ，go 命令 学习 ，本地运行 gotour

				
			

			

				

					freewebsys的专栏
				

				

					03-31
					
					488
					
				

			

		

		

			
				
首先要安装环境 参考：
 
http://toeo.iteye.com/blog/1470598

 
找了半天 没有 看明白 doc 的目录结构。
 
原来 doc 是web 展示的 ！！！
 
本地 运行 web 版本 doc文档
 
输入 
 
 
> godoc -http=:6060
 
 
 然后在浏览器里面就可以看到了：
 

 
访问...

			
		

	





	

		

			

				
					
Go语言RESTful API文档自动化：自动生成API文档的秘诀

				
			

			

				

					
				

			

		

		

			
				
[Go语言RESTful API文档自动化：自动生成API文档的秘诀](https://kennethlange.com/wp-content/uploads/2020/04/customer_rest_api.png) # 1. Go语言RESTful API基础知识  ## 1.1 RESTful API的基本概念 RESTful API...

			
		

	





	

		

			

				
					
Go语言文档自动化：Swagger与GoDoc联动生成实践

				
			

			

				

					
				

			

		

		

			
				
GoDoc是Go官方推荐的文档生成工具，其核心理念是通过代码注释自动生成包级别的API文档。与Swagger不同的是，GoDoc更侧重于模块内部的函数、方法、结构体等元素的说明，适合用于构建项目的内部开发文档或SDK文档。...

			
		

	





	

		

			

				
					
【Golang学习笔记】swagger自动化api文档生成

				
			

			

				

					FixPng的博客
				

				

					02-21
					
					751
					
				

			

		

		

			
				
参照b站大佬的教程视频，golang-swagger自动化api文档生成，从安装到demo跑起来图文全过程。

			
		

	





	

		

			

				
					
godoc

				
			

			

				

					weixin_30797027的博客
				

				

					11-30
					
					324
					
				

			

		

		

			
				
Godoc-一个Go代码文档化工具Python - DocstringJava - javadoc 


转载于:https://www.cnblogs.com/jinhh/p/10042252.html

			
		

	





	

		

			

				
					
Go语言 godoc.exe下载，查看包源码

				
			

			

				

					02-16
				

			

		

		

			
				
Go语言 godoc.exe下载。可以查看包的源码。直接解压到go目录下bin文件夹下即可，跟go和gofmt 并存。

			
		

	





	

		

			

				
					
Golang软件包，用于从httptest生成API文档。 查看示例输出-Golang开发

				
			

			

				

					05-26
				

			

		

		

			
				
go-httpdoc go-httpdoc是一个Golang软件包，用于从httptest测试用例生成API文档。
它提供了一个简单的http中间件，该中间件可以记录来自测试的http请求和响应，并自动生成文档go-httpdoc go-httpdoc是一个Golang软件包，可以从httptest测试用例生成API文档。
它提供了一个简单的http中间件，该中间件可以记录来自测试的http请求和响应，并以markdown格式自动生成文档。
请参阅样本文档。
它还提供了一种方法来验证值是否等于注释所期望的值（例如，您可以添加标题，参数或响应字段的描述）。
如果编写适当的测试，它将生成可用的文档



			
		

	





	

		

			

				
					
Go-adoc是一个用于生成api文档的工具

				
			

			

				

					08-14
				

			

		

		

			
				
adoc是一个文档生成工具，根据golang代码注释，生成README格式的API文档，只能识别特定的API注释语法。

			
		

	





	

		

			

				
					
goclipse godoc.exe

				
			

			

				

					04-24
				

			

		

		

			
				
windows下用eclipse+goclipse插件 godoc.exe windows下用eclipse+goclipse插件 godoc.exe

			
		

	





	

		

			

				
					
godoc:go开发的文档管理系统

				
			

			

				

					03-11
				

			

		

		

			
				
戈多克
go开发的一个简单易用的文档管理系统，用于API等文档的管理
特色
采用golang开发，部署简单
只有一个执行文件，不依赖任何前端静态资源
文档采用markdown编辑，程序员的最爱
运行
去release下载编译好的执行文件
创建数据库（godoc-utf8mb4 / utf8mb4_general_ci）并导入godoc.sql
在env.ini.dev => env.ini文件中配置数据库信息
执行相应操作系统的并发症文件
访问： localhost:8000
 log.xml.dev => log.xml为日志配置文件，如有需要，请修改此文件
如果您是golang开发者，可以下载源码， go get github.com/iiinsomnia/yiigo后自己运行
Mac和Linux
 cd /godoc
# mac
./godoc_darwin
# 如需后台运行，则：


			
		

	





	

		

			

				
					
go语言_官方文档 godoc

				
			

			

				

					迎难而上
				

				

					07-07
					
					6469
					
				

			

		

		

			
				
doc作为开发中的帮助文档, 非常的重要, 但是由于网络原因golang.com,国内用户可能不能访问，那要怎么查看doc呢

方法1

查看 fmt 包

cmd go doc fmt    

查看单个函数  Printf

cmd godoc fmt Printf




方法2


生成本地官网

cmd godoc -http=:8080

访

			
		

	





	

		

			

				
					
Golang 见证 godoc 的强大（生成API文档，打印文档）

				
			

			

				

					qq_43256905的博客
				

				

					12-21
					
					1770
					
				

			

		

		

			
				
Golang 自动生成 API 文档
文章目录Golang 自动生成 API 文档一、
一、



			
		

	





	

		

			

				
					
godoc命令文档

				
			

			

				

					夏日白云的boke
				

				

					09-17
					
					720
					
				

			

		

		

			
				
这是godoc命令的官方文档的翻译，一起来学习下怎么在本地启动go文档服务器吧

			
		

	



              




          




        



    





    



      

      

        
      

      





	

		评论	
	

  

	
    

      

      

      

        
        

          
          

            

              成就一亿技术人!
            

            

              拼手气红包6.0元
            

          

        

        

          

            还能输入1000个字符
          

          

             
          

          

            

              红包
              添加红包
            

            

              表情包
              插入表情
              

                

              

            

            

              表情包
              代码片
              

                
              

            

            

              
              
              
              
              
              
              
            

          

        

      

    

		

			

			

			

					 条评论被折叠 查看
			

			

				
			

		

	

	




  

    

      添加红包
      
    

    

      

        
        

          
          
        

        
请填写红包祝福语或标题

      

      

        
        

          
          个
        

        
红包个数最小为10个

      

      

        
        

          
          元
        

        
红包金额最低5元

      

      

        
        

          当前余额3.43元
          前往充值 >
        

      

      

        

          需支付：10.00元
        

        
        
      

    

  





  

    
    
  

  

    
    
  








  

    

      

        

          

            
            
成就一亿技术人!

          

          

        

        

          

          

            领取后你会自动成为博主和红包主的粉丝
            规则
          

        

      

      

        

          

            
              
            
            

              
hope_wisdom
 发出的红包
            

          

        

        

          

          

          

        

      

    

    

  



      
      

      
实付元

      
使用余额支付

      

        

          

            
            点击重新获取
          

        

        
扫码支付

      

      

        
          
            
          
          
        
      

      

        
        钱包余额
          0
          

            
            

              

                
抵扣说明：

                
 1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
 2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

              

            

          

      

      余额充值