ヘッダードキュメント

ヘッダードキュメント
開発者	アップル社
初回リリース	2000年9月13日
安定版リリース	8.9 / 2009年6月8日
書かれた	Perl、C（ヘルパー）
オペレーティング·システム	Mac OS X、UNIX、Linux
タイプ	ドキュメントジェネレーター
ライセンス	Apple パブリックソースライセンス2.0
Webサイト	developer.apple.com/opensource/tools/headerdoc.html

HeaderDocは、 Apple Inc.が開発および保守するドキュメント生成ツールです。HeaderDoc は、特別にコメントされたソースコードファイルを入力として、HTMLまたはXML形式でコードのドキュメントを生成します。HeaderDocコメントタグの構文は、HeaderDocバージョン8以降ではJavadocタグとほぼ同様であり、Javadocタグをサポートしています。HeaderDoc 8.7以降では、多くのDoxygenタグ（@形式のみ、HeaderDocタグの順序付けルールに準拠する必要があります）も部分的にサポートしています。AppleのHeaderDocプロジェクトは、 Apple Public Source Licenseに基づいて配布される無料のオープンソースソフトウェアです。

サポートされているプレーンテキスト言語

• AppleScript
• バッシュ
• ボーンシェル
• Cシェル
• C
• C++
• コーンシェル
• ジャワ
• JavaScript
• マッハMIGの定義[1]
• Objective-C
• パスカル
• パール
• PHP
• パイソン
• ルビー
• Tcl

HeaderDocツールセットは、メインユーティリティ、headerdoc2html、gatherheaderdocで構成されています。headerdoc2htmlツールは、指定されたコメント付きソースファイルからHTMLファイル（またはオプションでXMLファイル）のディレクトリを生成します。その後、gatherheaderdocユーティリティを実行してドキュメントの目次ファイルを作成できます。最後に、resolveLinksユーティリティを使用して、複数のドキュメントコレクション間の相互参照を解決できます。

Apple のXcode開発環境には、HeaderDoc 構文とツールを使用してドキュメントを作成するプロセスを支援するように設計された機能が含まれています。

追加機能

HeaderDoc には次のコア機能があります。

• C プリプロセスにより、ユーザーが選択した #define マクロでコンテンツを変更したり、ユーザーがコマンドライン フラグを渡して入力の一部を無視したりできるようになります。
• ユーザー定義のスタイルによる構文の色分け。
• インデックス用のテンプレート駆動型ランディング ページ。
• クロスプラットフォーム (主に Perl で書かれています)。

HeaderDoc スイートには、独立して使用できるツールもいくつか含まれています。

• MPGL は、XHTML のサブセットとセクション タグ、パラメータ タグなどで構成される軽量 XML 構文を使用して UNIX マニュアル ページの作成を簡素化するように設計されたツール セットです。HeaderDoc は、HeaderDoc の XML 出力モードを使用して関数のヘッダー コメントからマニュアル ページを生成するのに役立つブリッジ ツールも提供します。
• resolveLinks — 埋め込みアンカーとリンク リクエストを使用してコンテンツが別のアドレスに移動した場合に、Web サイトを迅速に再リンクできるツールです。
• filtermacros.pl—Cプリプロセッサマクロに基づいてヘッダーセクションをフィルタリングできるツールです。現在はソースtarballをダウンロードすることでのみ利用可能です。HeaderDoc 8.9以降、この機能はheaderdoc2htmlツール自体に組み込まれています。

参照

• 無料のオープンソースソフトウェアポータル

• ドキュメントジェネレータの比較
• 標準インターフェースドキュメント

外部リンク

• レガシードキュメント: HeaderDoc ユーザーガイド
• http://opensource.apple.com [最新バージョン] (現在 8.9.28)
• HeaderDoc メーリング リストはWayback Machineに 2010-01-06 にアーカイブされています(通常、ヘルプやパッチなどを取得するために使用されます)