草庐IT

go - 如何使用 godoc 为文件夹内的所有包生成 HTML 文档

godoc-html只为一个包生成文档。但是,我想将项目与所有包的所有文档一起发送,就像我运行godoc-http时一样。有了它,我可以找到所有包并从浏览器中浏览它们。是否可以通过godoc-html为所有链接在一起的包生成HTML页面? 最佳答案 这里有两个问题:IsitpossibletogenerateHTMLpagesforallpackageslinkedtogetherthroughgodoc-html?没有。因为它没有在godoc(https://godoc.org/golang.org/x/tools/cmd/god

go - 从包的 godoc 引用不同的包

有人可以让我知道是否可以从包的godoc引用不同的包吗?例如,假设我有一个包src/logger/。在src/logger/doc.go中,我需要引用src/config/。类似于javadoc中的@see。有推荐的方法吗?我正在使用Go1.7。 最佳答案 我不知道这是目前可能的。例如。https://golang.org/pkg/io/ioutil/#TempFile简单地使用*os.File引用os包。在https://golang.org/src/io/ioutil/tempfile.go#L40查看源代码注释.andwrit

go - 使用不同的链接文本创建 godoc URL

根据"Godoc:documentingGocode"博文:URLswillbeconvertedtoHTMLlinks;nospecialmarkupisnecessary.但是,有没有一种方法可以创建链接文本与URL不同的HTML链接? 最佳答案 Go1.19引入了一种指定链接文本的格式。链接文本内嵌在方括号中:[LinkText]。链接目标在单独的一行中指定,如下所示:[LinkText]:https://example.com/link/target参见GoDocCommentdocumentation了解完整详情。Go1.

go - godoc中的图像?

有什么方法可以将图像(本地或远程)添加到godoc生成的HTML版本中?这对于包含无法用文字轻松解释的图表非常有用。 最佳答案 godoc工具不提供将图像添加到文档的方法。 关于go-godoc中的图像?,我们在StackOverflow上找到一个类似的问题: https://stackoverflow.com/questions/37668656/

macos - 在 OS X 中自动启动 godoc localhost 服务器?

在Go中,您可以启动HTTP服务器,然后通过特定端口浏览Go文档。例如,如果您在终端中输入godoc-http=:3333,localhost服务器将开始在端口3333上工作,然后您可以查看官方Go文档。但是,我想让它在我登录OSX系统时自动启动,因为即使在我断开Wi-Fi连接时,用Go代码编写它也非常强大和方便。那么在OSX中使用这样的守护进程是否可行?我已经在anexamplehere中实现并使用了MongoDB中的确切功能,而我想要实现的正是这种服务...... 最佳答案 将其放入文件夹~/Library/LaunchAgen

go - 在导出名称中排除 godocs 是一种不好的形式吗?

根据《有效围棋》golang.org/doc/effective_goEveryexported(capitalized)nameinaprogramshouldhaveadoccomment.假设我在一个简单的网络应用程序上有一个View处理程序//HandlethefrontpageofthewebsitefuncFrontPageView(whttp.ResponseWriter,r*http.Request){controllers.RenderBasicPage(w,"frontPage")}我的问题是:godoc真的有必要吗?也许我现在只是爱上了RobertMartin的C

go - 你如何为使用 godoc 作为网页的 go 程序提供简单的文档?

我试图将特定的本地go文件作为文档网页提供,但无法做到。officialgodocdocumentation说:Withthe-httpflag(i.e.thegodoccommand),itrunsasawebserverandpresentsthedocumentationasawebpage.user_me$godoc-http=:6060这确实会创建类似于go页面的内容,但它不会呈现我想要呈现的特定文件。所以我尝试提供我想要的文件名:user_me$godoc-http=:6000hello.go但是,它只是回复:usage:godocpackage[name...]godoc

go - 如何使用 `godoc` 生成 HTML 文档?

我写了一个小go程序,我想从源代码生成独立的HTML文档,可以在没有godoc服务器的情况下查看。但我找不到任何方法来实现它。如果有人可以帮助我,我将不胜感激。 最佳答案 可以通过以下方式生成更好的形式:godoc-url"http://localhost:6060/pkg/container/heap/">page.html(我的godoc服务器在:6060运行,我不确定这是否是先决条件)。如果通过调整生成的HTML文件以正确引用它,结合在Go存储库中找到的原始CSS样式,HTML可能看起来会更好。

go - 在 Godoc 中记录 `package main` 需要哪些步骤?

Godoc是记录包的好工具,但是当它用于packagemain时,它似乎没那么有用了。我将看到一个仅显示我使用//BUG和子目录写给自己的笔记的输出。Godoc只显示导出的函数,似乎无法从main中显示未导出的/函数。我会发现在main.js中查看函数列表很有用。由于不支持此功能,因此我倾向于将函数列表放在包说明的顶部,但这感觉像是一种解决方法。由于我必须手动更新函数列表,因此我经常将尽可能多的代码放入包中,以便将其导出并记录在案。这是一个好主意吗?main中的函数列表该怎么办?例子:COMMANDDOCUMENTATIONPackagemainimplementsawebserver

go - 在 Godoc 中记录 `package main` 需要哪些步骤?

Godoc是记录包的好工具,但是当它用于packagemain时,它似乎没那么有用了。我将看到一个仅显示我使用//BUG和子目录写给自己的笔记的输出。Godoc只显示导出的函数,似乎无法从main中显示未导出的/函数。我会发现在main.js中查看函数列表很有用。由于不支持此功能,因此我倾向于将函数列表放在包说明的顶部,但这感觉像是一种解决方法。由于我必须手动更新函数列表,因此我经常将尽可能多的代码放入包中,以便将其导出并记录在案。这是一个好主意吗?main中的函数列表该怎么办?例子:COMMANDDOCUMENTATIONPackagemainimplementsawebserver