如何使用 godoc 创建文档？

Question

我创建了简单的 go with comment in the application to the function and the package 我尝试了 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以查看它们：godoc 服务的网页的呈现方式可以通过“m”URL 参数来控制；它接受以逗号分隔的标志名称列表作为值：all     show documentation for all declarations, not just the exported onesmethods show all embedded methods, not just those of unexported anonymous fieldssrc     show the original source code rather then the extracted documentation