Как создать документ в GO с Godoc? - PullRequest
Новая
       14

Как создать документ в GO с Godoc?

0 голосов
/ 07 ноября 2018

создаю простой go с комментарием в приложении к функции и пакету Я попробовал 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 {

}

1 Ответ

0 голосов
/ 07 ноября 2018

Неэкспортированные идентификаторы не задокументированы по умолчанию. Установите как минимум ?m=all, чтобы увидеть их:

Режим представления веб-страниц, обслуживаемых godoc, можно контролировать с помощью параметра URL "m"; в качестве значения он принимает список имен флагов через запятую: 

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

...