jjzjj

api - 为 API 库生成更好的 GoDoc

我用Go实现了一个典型的RESTAPI库。但是由于端点的数量和不同的数据结构,端点之间几乎没有共享的数据结构,项目的GoDoc非常困惑:它现在的结构方式使得很难看到实际函数返回的内容,需要大量滚动文档才能找到与数据相关的结构。端点都是API结构的一部分,因为它们可以在API调用之间共享身份验证状态,这导致它们全部列在GW2Api结构下方,而不是它们关联的数据结构。除了GoDoc之外,还有什么好的方法可以让库API更清晰吗?向函数调用添加注释? 最佳答案 我认为很好的一个api包的例子是github包装器:https://godoc.

带有 CRLF 的 godoc 示例输出

我写了下面的方法:func(c*Component)Encode(wio.Writer){//encodescandwritesthebytesintow,containingafewCRLFlinebreaks}我还编写了演示编码器的函数:funcExampleComponent_Encode(){c:=&Component{Name:"DESCRIPTION",}c.Encode(os.Stdout)//Output://BEGIN:DESCRIPTION//END:DESCRIPTION}现在的问题是这个例子没有通过gotest命令,因为注释中的换行符是\n换行符(我在Linux

带有 CRLF 的 godoc 示例输出

我写了下面的方法:func(c*Component)Encode(wio.Writer){//encodescandwritesthebytesintow,containingafewCRLFlinebreaks}我还编写了演示编码器的函数:funcExampleComponent_Encode(){c:=&Component{Name:"DESCRIPTION",}c.Encode(os.Stdout)//Output://BEGIN:DESCRIPTION//END:DESCRIPTION}现在的问题是这个例子没有通过gotest命令,因为注释中的换行符是\n换行符(我在Linux

没有显示源代码的godoc

我有几个与godoc兼容的Go项目。我们使用godoc作为文档服务器在内部共享文档和代码,没有重大问题。然而,当我们想与第三方共享文档时,我们需要更多地控制打开代码。有没有办法在显示类型和文档但从不链接或显示源代码的特殊模式下运行godoc?我试过了godoc-http=0.0.0.0:8090-links=false-src=false但不工作,仍然可以链接到类型定义代码。只是想知道是否错过了某事。Go版本,1.3。 最佳答案 src文件只指命令行模式,不指服务器模式,所以对你没有帮助。在我看来,有几个选项:根据您的需要重写god

没有显示源代码的godoc

我有几个与godoc兼容的Go项目。我们使用godoc作为文档服务器在内部共享文档和代码,没有重大问题。然而,当我们想与第三方共享文档时,我们需要更多地控制打开代码。有没有办法在显示类型和文档但从不链接或显示源代码的特殊模式下运行godoc?我试过了godoc-http=0.0.0.0:8090-links=false-src=false但不工作,仍然可以链接到类型定义代码。只是想知道是否错过了某事。Go版本,1.3。 最佳答案 src文件只指命令行模式,不指服务器模式,所以对你没有帮助。在我看来,有几个选项:根据您的需要重写god

github - 如何使godoc链接到github上的源代码

在godoc站点上,大多数库(例如http://godoc.org/github.com/beego/memcache)直接链接到github上的源代码。当我在本地运行godoc工具时,情况并非如此。我们的团队也有一个本地godoc服务器,它同样没有链接到github上的源代码。我们的代码存储在github上,并进行了相应的组织(即github.com/mycompany/packagename)。有没有办法告诉godoc工具链接到github上的代码,即使它在私有(private)仓库中? 最佳答案 如评论中所述,godoc(Go

github - 如何使godoc链接到github上的源代码

在godoc站点上,大多数库(例如http://godoc.org/github.com/beego/memcache)直接链接到github上的源代码。当我在本地运行godoc工具时,情况并非如此。我们的团队也有一个本地godoc服务器,它同样没有链接到github上的源代码。我们的代码存储在github上,并进行了相应的组织(即github.com/mycompany/packagename)。有没有办法告诉godoc工具链接到github上的代码,即使它在私有(private)仓库中? 最佳答案 如评论中所述,godoc(Go

go - 如何使用 `godoc -http=:6060` 显示内置类型?

如果我开始godoc-http=:6060然后打开http://localhost:6060/pkg/builtin/#string(例如,通过一个使用string作为某处类型的函数声明),我得到一个大红色“打开/usr/local/Cellar/go/1.3.3/libexec/src/builtin:没有那个文件或目录”。如何让godoc以与http://golang.org/pkg/builtin/#string相同的方式工作?我尝试了gogetbuiltin,但这并没有改变任何东西。DuckDuckGo和Google搜索也没有启发我。(我在OSX上使用Homebrew安装了Go

go - 如何使用 `godoc -http=:6060` 显示内置类型?

如果我开始godoc-http=:6060然后打开http://localhost:6060/pkg/builtin/#string(例如,通过一个使用string作为某处类型的函数声明),我得到一个大红色“打开/usr/local/Cellar/go/1.3.3/libexec/src/builtin:没有那个文件或目录”。如何让godoc以与http://golang.org/pkg/builtin/#string相同的方式工作?我尝试了gogetbuiltin,但这并没有改变任何东西。DuckDuckGo和Google搜索也没有启发我。(我在OSX上使用Homebrew安装了Go

go - 如何在 Godoc 中包含可播放的示例

如何使Golang示例可玩?我有以下代码:funcExample_authenticate(){fmt.Println("hello")//Output:JSON}我是否需要在某处添加可播放代码才能在Doc中获取它? 最佳答案 您必须使用-play标志运行godoc:$godoc--help..........-play=false:enableplaygroundinwebinterface例如运行godoc-http=:9020-play然后转到http://localhost:9020/pkg/encoding/json/#e