Question

我在应用程序中对函数和程序包创建了简单的注释我尝试了godoc -html和我的应用程序以及结果

<!--
    Copyright 2009 The Go Authors. All rights reserved.
    Use of this source code is governed by a BSD-style
    license that can be found in the LICENSE file.
-->

<!--
        Note: Static (i.e., not template-generated) href and id
        attributes start with "pkg-" to make it impossible for
        them to conflict with generated attributes (some of which
        correspond to Go identifiers).
-->

        <script type='text/javascript'>
        document.ANALYSIS_DATA = ;
        document.CALLGRAPH = ;
        </script>



                <p>
Package main provides logic ...
</p>

为什么我没有看到其他文件？以及软件包的<p>为何有空格

// Package main provides logic.
package main
import (

}

some types.....

func main() {
}

// doLogic .....
// .....
// ....
func (sm *myI) doLogic (s *myStruct) bool {

}

Answer 1

默认情况下未记录未导出的标识符。至少设置?m=all才能看到它们：

可以使用“ m” URL参数来控制godoc服务的网页的显示方式；它接受以逗号分隔的标志名称列表作为值：
all     show documentation for all declarations, not just the exported ones
methods show all embedded methods, not just those of unexported anonymous fields
src     show the original source code rather then the extracted documentation
例如，https://golang.org/pkg/math/big/?m=all显示了big包的所有（不仅是导出的）声明的文档。 https://godoc.org/golang.org/x/tools/cmd/godoc

如何使用godoc在GO中创建文档？

1 个答案: