【问题标题】:Can't godoc create documentation for packages within internal folder?godoc 不能为内部文件夹中的包创建文档吗?
【发布时间】:2021-07-15 00:36:47
【问题描述】:

在一个常见的项目结构中有如下文件夹:

/cmd

/内部

/包

但是在执行godoc

没有为 internal 文件夹中的包创建文档: internal is missing between cmd and pkg

问题是:包中有函数,即使内部使用也需要记录。有什么办法吗?

【问题讨论】:

    标签: go godoc


    【解决方案1】:

    例如,https://golang.org/pkg/math/big/?m=all 显示 包的所有(不仅仅是导出的)声明的文档 大。

    正如documentation 中提到的,在 URL 中使用 m=all 参数将列出内部包。需要注意的是,它包括所有声明,包括未导出的声明。

    【讨论】:

    • 一个技巧是包含 m=all 以列出内部包并导航到内部包。然后您可以删除 m=all 标志以仅列出内部包中的导出声明。
    • 谢谢你们俩。有用。我实际上认为可以为这个功能提供一个 cli 标志。这样就有点糊涂了。还有go doc -all所以...
    猜你喜欢
    • 2018-08-27
    • 2019-04-10
    • 1970-01-01
    • 2013-11-26
    • 2015-12-28
    • 1970-01-01
    • 1970-01-01
    • 2016-11-14
    • 1970-01-01
    相关资源
    最近更新 更多