Как сгенерировать документ из программы go в go1.13 - PullRequest
0 голосов
/ 26 октября 2019

Вот небольшая программа toto.go

// Copyright Some Company Corp.
// All Rights Reserved
package main


// here are the imports
import (
    "fmt"
)

// function to say hello
func hello() {
    fmt.Println("hello world")

}

// Main function here
func main() {
    hello()
}

Как сгенерировать HTML-документацию из этого кода?

Результат:

godoc -html  github.com/bussiere/GoTestDoc 
flag provided but not defined: -html
usage: godoc -http=localhost:6060
  -analysis string
        comma-separated list of analyses to perform (supported: type, pointer). See http://golang.org/lib/godoc/analysis/help.html
  -goroot string
        Go root directory (default "/usr/lib/go-1.13")
  -http string
        HTTP service address (default "localhost:6060")
  -index
        enable search index
  -index_files string
        glob pattern specifying index files; if not empty, the index is read from these files in sorted order
  -index_interval duration
        interval of indexing; 0 for default (5m), negative to only index once at startup
  -index_throttle float
        index throttle value; 0.0 = no time allocated, 1.0 = full throttle (default 0.75)
  -links
        link identifiers to their declarations (default true)
  -maxresults int
        maximum number of full text search results shown (default 10000)
  -notes string
        regular expression matching note markers to show (default "BUG")
  -play
        enable playground
  -templates string
        load templates/JS/CSS from disk in this directory
  -timestamps
        show timestamps with directory listings
  -url string
        print HTML for named URL
  -v    verbose mode
  -write_index
        write index to a file; the file name must be specified with -index_files
  -zip string
        zip file providing the file system to serve; disabled if empty

Так кажетсямногое изменилось с прошлого раза. И, кажется, трудно найти учебник и документацию, чтобы сделать документ для golang в go1.13

Ответы [ 2 ]

2 голосов
/ 26 октября 2019

Это то, что вы можете искать

godoc -html <package-name>

Вы можете обратиться к этой ссылке для получения более подробной информации

0 голосов
/ 26 октября 2019
  1. Переместите папку вашего пакета в каталог GOPATH.
$GOPATH/src/github.com/username/my-package

Используйте godoc для создания документации для проекта go.

  • Для создания HTML-документа
godoc -html  github.com/username/my-package
  • Альтернативный вариант:
godoc -http=:6060

СейчасВы можете посетить http://localhost:6060/pkg/github.com/username/my-package, чтобы просмотреть документацию вашего пакета.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...