tools.md

パッケージ: main

1. 概要

パッケージmainは、Goパッケージのドキュメントを自動生成するためのコマンドラインツールを提供します。 このスクリプトは、抽象構文木（AST）を解析し、パッケージの構造体、関数、型情報からMarkdownドキュメントを生成します。

2. 型

2-1. FieldInfo

構造体のフィールド情報を保持する構造体です。 フィールド名と型情報を格納します。

2-1-1. フィールド

• Name: string

• Type: string

2-2. FunctionInfo

解析された関数の情報を保持する構造体です。 関数名、ドキュメント、シグネチャ情報を格納します。

2-2-1. フィールド

• Name: string

• Doc: string

• Signature: string

2-3. PackageInfo

解析されたGoパッケージの情報を保持する構造体です。 パッケージ名、ドキュメント、型、関数の情報を格納します。

2-3-1. フィールド

• Name: string

• Doc: string

• Types: []TypeInfo

• Functions: []FunctionInfo

2-4. TypeInfo

解析された型の情報を保持する構造体です。 型の名前、ドキュメント、フィールド情報を格納します。

2-4-1. フィールド

• Name: string

• Doc: string

• Fields: []FieldInfo

3. 関数

3-1. cleanupDoc

テキストドキュメントの空行を整理し、余分な空白を削除する関数です。 連続する空行を1行に削減し、先頭と末尾の空行を取り除きます。

3-2. cleanupMarkdown

生成されたMarkdownドキュメントの余分な空行や空白を削除する関数です。 連続する空行を2行以下に制限し、行末の不要な空白を取り除きます。

3-3. formatTypeString

AST型式を読みやすい文字列形式に変換する関数です。 ポインタ型、配列型、パッケージ修飾型などを適切にフォーマットします。

3-4. generateDocumentation

パッケージ情報からMarkdownドキュメントを生成する関数です。 抽出したパッケージ情報とテンプレートを使用して、ドキュメントファイルを作成します。

3-5. main

コマンドライン引数からパッケージパス、テンプレートファイル、出力ファイルを受け取り、 ドキュメント生成プロセスを実行します。