Godoc拥有自己的源代码

时间:2014-09-08 11:07:31

标签: godoc

我想在文件夹" MyOwnProject"中为我自己的项目创建文档。 Standard似乎是Godoc,帮助告诉我使用godoc包[name ...] 它看起来似乎并不艰难:

godoc package MyOwnProject -path ..../go
-> Cannot find file ..../go/src/pkg/package

godoc MyOwnProject -path ..../go
-> Cannot find file ..../go/src/pkg/MyOwnProject

首先,目录/ src / pkg / it添加没有任何意义,东西在go / pkg或go / src中。接下来它似乎在寻找单个文件。我希望它能够处理为该项目提供的所有文件。我的参数怎么办?

1 个答案:

答案 0 :(得分:1)

package中的usage: godoc package [name ...]一词是包裹全名的占位符,[name ...]是您想要限制的特定功能/变量名称的占位符搜索到。这三个点意味着您可以指定多个名称。方括号表示它是可选的。

如果您的软件包位于$GOPATH/src/MyOwnProject,则其全名只是MyOwnProject,您只需输入以获取软件包的完整文档即可:

godoc MyOwnProject