ドキュメンテーションジェネレータ（英: documentation generator）は、特別なコメントが記述されたソースコードファイル（ソースファイル）の集合、または一部の例ではバイナリファイルの集合から、プログラマ向けのAPIリファレンス（プログラミングガイド）やエンドユーザー向けのマニュアル（エンドユーザーガイド）、またはその両方を対象としたドキュメンテーションを生成するプログラミングツールである。 プログラミング言語の場合、ソースファイルやヘッダーファイル自身、名前空間またはパッケージ、ユーザー定義のデータ型（列挙型や構造体やクラスなど）、サブルーチン（関数）、構造体やクラスのメンバー（フィールドやメソッドやコンストラクタなど）、グローバル変数あるいは定数、といったプログラムの構成要素の宣言または定義に対して、一定の構文規則を持つコメントを前置または後置したものを、ジェネレータプログラムにパースさせることでドキュメントを生成する。
ドキュメンテーションジェネレータ（英: documentation generator）は、特別なコメントが記述されたソースコードファイル（ソースファイル）の集合、または一部の例ではバイナリファイルの集合から、プログラマ向けのAPIリファレンス（プログラミングガイド）やエンドユーザー向けのマニュアル（エンドユーザーガイド）、またはその両方を対象としたドキュメンテーションを生成するプログラミングツールである。 プログラミング言語の場合、ソースファイルやヘッダーファイル自身、名前空間またはパッケージ、ユーザー定義のデータ型（列挙型や構造体やクラスなど）、サブルーチン（関数）、構造体やクラスのメンバー（フィールドやメソッドやコンストラクタなど）、グローバル変数あるいは定数、といったプログラムの構成要素の宣言または定義に対して、一定の構文規則を持つコメントを前置または後置したものを、ジェネレータプログラムにパースさせることでドキュメントを生成する。
出典: Wikipedia「ドキュメンテーションジェネレータ」 · CC BY-SA 4.0
この記事を共有: X · Bluesky