記載された方法を用いてgodoc

A、外出先でドキュメントのプロフィール

Godocはドキュメンテーション文字列はPythonとJavaのJavadocに似て行く言語文書化ツール、同様の文書化ツールのgodoc、ある
コメントを含む囲碁コードを解析することによって、文書のHTMLまたはテキストタイプを生成するGodoc。

第二に、交戦規則

godoc
ゴー注釈ルールは非常に簡単で、直接これらの文の前に一般的なコメントの形で書かれた型、変数、定数、関数、またはパッケージにコメントを書くときに、真ん中の列は空白のままにすることはできません。ドキュメントの目的を達成するために一緒に接続されてこれらのコメントとステートメントの後ろGodoc。

注// 1.空白の後

// 这是一行注释
package main

2.次のキーワードへのコメント行を書き、それが認識されません

// 不会被识别

// 会被识别
package main

// 不会被识别

// 会被识别1
// 会被识别2
func main（）{

}

3.コメント行の数が3行を超えてはなりません

4.既知のバグ注：BUG（だれ）

godoc出力は、1つの例外を除き、それはで始まる（）コメントBUGあり、それらのステートメントは、隣接するトップノートではありません無視します。これらのノートは、既知のバグとして識別され、BUGS領域が文書に含まれています。

// 注释
package main


// BUG(who)  //会被识别，放入文档的Bugs区


const a = 8

第三に、コマンドを使用します。

.GOドキュメントディレクトリに実行するコマンドを入力するには、行の最初にある
例を：/ GoProject / SRC /テスト/ディレクトリ：Cのマイtest.go
/ GoProject / SRC /テスト/：コマンドラインCを入力する必要があり
、その後のコマンドを実行

 godoc -http=:6060     //6060是godoc提供的默认端口

ブラウザでは、localhostを入力します：6060
、あなたはパスlocalhostと入力し、godocサイトを入力してアドレスバーに必要な彼らのマニュアルを確認することができます：6060 / PKG /テスト