为了账号安全,请及时绑定邮箱和手机立即绑定

简单的 hello world 程序的 Go doc

简单的 hello world 程序的 Go doc

Go
慕桂英546537 2022-11-23 10:19:06

如何编写一个 go 程序,使其有一个简单的文档


例子


package HelloWorld


import "fmt"


func HelloWorld() {

    fmt.Println("hello world")

}

如果 exec 对此代码进行更改后


go doc <needed command>

它应该打印


this is a hello world program 


查看完整描述

2 回答

?
Cats萌萌

TA贡献1530条经验 获得超9个赞

在包声明之前的注释中输入文档,它们之间不留空行。


例如:


/*

This is a hello world program.

*/

package main

然后将包提供给go doc,如下所示:


go doc path/to/your/package

输出将是:


This is a hello world program.


查看完整回答
反对 回复 2022-11-23
?
Qyouu

TA贡献1488条经验 获得超10个赞

我不是 100% 确定你要什么。但是你可以像这样描述一个 go 包,并且go doc会接受这个。

// this is some description for the package
package mypackage

然后您可以使用浏览器查看文档

godoc -http=:6060

使用 GoDoc 可以完成许多技巧,这些技巧在这个Github 存储库 - godoc-tricksGo 团队的这篇博客文章中有所描述。


查看完整回答
反对 回复 2022-11-23

添加回答

举报

0/150
提交
取消
意见反馈 帮助中心 APP下载
官方微信