0

0

Golang包文档生成工具_使用pkgsite本地查看项目文档

P粉602998670

P粉602998670

发布时间:2026-02-17 08:51:45

|

208人浏览过

|

来源于php中文网

原创

不能,pkgsite默认只服务proxy.golang.org已发布的模块;需配置本地goproxy、合法go.mod路径、手动go mod download,并设goproxy指向本地代理才能加载本地未发布模块。

golang包文档生成工具_使用pkgsite本地查看项目文档

pkgsite 能不能直接看本地 Go 项目文档?

不能,pkgsite 默认只服务已发布到 proxy.golang.org 的模块,本地未发布的代码不会被自动索引。它不是 godoc 那种开箱即用的本地文档服务器。

想用 pkgsite 看自己写的包,必须让它的后端“认为”这个模块是可解析的——核心是伪造一个可用的模块路径,并让它能被 go list -m -jsongo mod download 流程识别。

  • 你的模块必须有 go.mod 文件,且 module 声明不能是伪路径(如 example.com/myproj 可以,./myproj 不行)
  • 需要在本地启动 pkgsite 并配置为使用本地 Go proxy 缓存(而非直连官方 proxy)
  • 首次访问前,得手动触发一次 go mod download,让模块进到本地 cache($GOCACHE/download)里

怎么让 pkgsite 读到本地未发布的模块?

关键是绕过远程 fetch,改用本地 goproxy + pkgsite 组合。最轻量的做法是用 goproxy 搭一个只服务本地模块的代理,再让 pkgsite 从它拉数据。

实操步骤:

立即学习go语言免费学习笔记(深入)”;

  • 确保 GO111MODULE=on,且项目根目录有合法 go.mod(比如 module github.com/you/proj
  • 运行 goproxy -proxy=localhost:8081 -cache=/tmp/goproxy-cache(它会监听本地 8081)
  • 设置环境变量:export GOPROXY=http://localhost:8081,direct
  • 执行 go mod download github.com/you/proj@latest —— 这步会把本地模块打个临时 tag 并缓存进去
  • 启动 pkgsitepkgsite -http=:8082 -proxy=http://localhost:8081
  • 浏览器打开 http://localhost:8082/github.com/you/proj

注意:pkgsite 不会实时监听文件变更,改了代码要重新 go mod download 才能刷新文档。

在Android中查看和管理sqlite数据库 中文WORD版
在Android中查看和管理sqlite数据库 中文WORD版

本文档主要讲述的是在Android中查看和管理sqlite数据库;在Android中可以使用Eclipse插件DDMS来查看,也可以使用Android工具包中的adb工具来查看。android项目中的sqlite数据库位于/data/data/项目包/databases中。有需要的朋友可以下载看看

下载

为什么 pkgsite 显示 “module not found” 却 go build 正常?

因为 pkgsite 查的是 module path(即 go.mod 第一行),不是文件路径。常见坑:

  • go.mod 里写的是 module .module myproj —— 这属于非法 module path,pkgsite 直接忽略
  • 模块路径含大写字母或下划线(如 MyProj),Go 官方工具链不认可,pkgsite 也不会处理
  • 本地没设 GOPROXYpkgsite 默认去 proxy.golang.org 找,自然 404
  • go list -m -json 在当前目录下执行失败(比如不在 module 根目录),pkgsite 就没法推导出有效路径

验证方法:在项目根目录运行 go list -m -json,输出里必须有非空的 Path 字段,且和浏览器访问的 URL 路径完全一致。

替代方案比硬刚 pkgsite 更省事?

如果只是临时查本地包结构、函数签名、注释,godoc(旧版)或 go doc CLI 更直接:

  • go doc -http=:6060 启动本地服务,访问 http://localhost:6060/pkg/ —— 支持未发布模块,实时响应
  • go doc github.com/you/projgo doc github.com/you/proj.MyFunc 查具体项
  • VS Code + Go 插件按 Ctrl+Click 跳转也能渲染大部分注释,无需额外服务

pkgsite 的优势在于 UI 和跨模块链接能力,但代价是强依赖模块发布流程。对纯本地开发来说,它不是默认最优解,而是特定部署场景下的选择。

真正卡住的往往是模块路径命名和 GOPROXY 链路是否闭环——这两点没对齐,后面所有步骤都白搭。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

207

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

238

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

347

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

212

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

403

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

344

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

197

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

908

2025.06.17

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

283

2026.02.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Go 教程
Go 教程

共32课时 | 5.2万人学习

Go语言实战之 GraphQL
Go语言实战之 GraphQL

共10课时 | 0.8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号