godoc没有显示源代码

时间:2015-08-02 05:49:23

标签: go documentation godoc

我得到了几个与godoc兼容的Go项目。我们使用godoc作为doc服务器在内部共享doc和代码而没有重大问题。但是,当我们想与第三方共享doc时,我们需要更多控制打开代码。有没有办法在显示类型和文档但从不链接或显示源代码的特殊模式下运行godoc?

我已经尝试了

godoc -http=0.0.0.0:8090 -links=false -src=false

但不工作,仍然可以链接到类型定义代码。只是想知道是否错过了......去版本,1.3。

1 个答案:

答案 0 :(得分:2)

src文件仅指命令行模式,而不是服务器模式,因此对您没有帮助。我看到的方式有几个选择:

  1. 根据您的需要重写godoc并使用自己的fork。

  2. 不要使用服务器模式,在命令行模式下呈现文档,只需创建一个服务器。

  3. 更好(我不完全确定2会起作用) - 稍微重写一下模板,这样源代码就不会被链接了。但是你仍然需要确保手动输入路径的人不会看到代码,所以它也需要捏造源模板。或...

  4. 也许最简单的事情 - 在nginx或类似的反向代理后面运行它,并确保服务器中的/src路径对外部访问者关闭,或密码保护或其他任何东西。这样你的内部团队仍然可以使用它。

  5. 就个人而言,我会选择4,这是几分钟的工作,将是最强大和最灵活的解决方案。