github.com/shogo82148/std@v1.22.1-0.20240327122250-4e474527810c/go/doc/comment/doc.go (about)

     1  // Copyright 2022 The Go Authors. All rights reserved.
     2  // Use of this source code is governed by a BSD-style
     3  // license that can be found in the LICENSE file.
     4  
     5  /*
     6  パッケージコメントは、Goのドキュメントコメント（ドキュメンテーションコメント）を解析および再フォーマットするためのものです。
     7  パッケージ、const、func、type、またはvarのトップレベルの宣言の直前にあるコメントを指します。
     8  
     9  Goのドキュメントコメントの構文は、リンク、見出し、段落、リスト（ネストなし）、および整形済みのテキストブロックをサポートする、
    10  Markdownの簡略化されたサブセットです。構文の詳細は、https://go.dev/doc/commentで文書化されています。
    11  
    12  （コメントマーカーを削除した後の）ドキュメントコメントに関連付けられたテキストを解析するには、[Parser]を使用します：
    13  
    14  	var p comment.Parser
    15  	doc := p.Parse(text)
    16  
    17  結果は、[*Doc]です。
    18  ドキュメントコメント、HTML、Markdown、またはプレーンテキストとして再フォーマットするには、[Printer]を使用します：
    19  
    20  	var pr comment.Printer
    21  	os.Stdout.Write(pr.Text(doc))
    22  
    23  [Parser]と[Printer]の型は、その操作をカスタマイズするために変更できる構造体です。
    24  詳細については、それらの型のドキュメントを参照してください。
    25  
    26  再フォーマットに追加の制御が必要な使用例では、解析された構文自体を検査することで独自のロジックを実装できます。
    27  概要および追加の型へのリンクについては、[Doc]、[Block]、[Text]のドキュメントを参照してください。
    28  */
    29  package comment