ゴードック
GoDocを使用して開発者がドキュメントを生成するヘルプ
参考文献https://golang.org/doc/effective_go
GoDocの生成はかなり簡単です.開発者は、パッケージの前にファイルの上にコメントを入れてから、自動的にDOCが生成されます.
コメント-ブロックコメント、およびラインコメントの2種類があります
1 .ブロックコメント
/* */コメントのいくつかの行について/*
Package regexp implements a simple library for regular expressions.
The syntax of the regular expressions accepted is:
regexp:
concatenation { '|' concatenation }
concatenation:
{ closure }
closure:
term [ '*' | '+' | '?' ]
term:
'^'
'$'
'.'
character
'[' [ '^' ] character-ranges ']'
'(' regexp ')'
*/
package regexp
//の使用// Package path implements utility routines for
// manipulating slash-separated filename paths.
何がコメントにあるべきですか?
それ以外の機能、インターフェイスまたはタイプなどの上にコメントを追加することができます
ローカルでGoDocを見る方法
パッケージへのA . CD
go doc
あなたがローカルウェブ上でそれを見たいならば
1 .ルートディレクトリの
go.modファイルを確認してくださいあなたがまだそれを持っていないならば
go mod init example/path
godoc
あなたが望むならば、あなたはあなた自身の港を指定することができます
godoc -http=localhost:8080
Reference
この問題について(ゴードック), 我々は、より多くの情報をここで見つけました https://dev.to/chestnut/go-doc-47ncテキストは自由に共有またはコピーできます。ただし、このドキュメントのURLは参考URLとして残しておいてください。
Collection and Share based on the CC Protocol