Categories: 未分類

HeaderDoc

HeaderDoc

HeaderDocは、Apple Incによって開発および保守されているドキュメントジェネレータです。特別にコメント化されたソースコードファイルを入力として使用して、HeaderDocはHTMLまたはXML形式のコードのドキュメントを生成します。HeaderDocコメントタグの構文は、HeaderDocバージョン8とほぼ同じであり、Javadocタグをサポートしています。HeaderDoc 8.7以降は、多くのDoxygenタグの部分的なサポートも提供します(@フォームのみ、HeaderDocタグの順序付け規則に準拠する必要があります)。AppleのHeaderDocプロジェクトは、Apple PublicSourceLicenseの下で配布されている無料のオープンソースソフトウェアです。 HeaderDoc 開発者
アップル社。
初回リリース
2000年9月13日
安定リリース
8.9/2009年6月8日
で書かれている
Perl、C(ヘルパー)
オペレーティング·システム
Mac OS X、UNIX、Linux
タイプ
ドキュメントジェネレータ
ライセンス
Apple Public Source License 2.0
Webサイト
開発者.apple.com / opensource / tools / headerdoc .html

コンテンツ
1 サポートされているプレーンテキスト言語
2 追加機能
3 も参照してください
4 外部リンク

サポートされているプレーンテキスト言語 AppleScript バッシュ
ボーンシェル
Cシェル C C ++Korn Shell Java JavaScript
MachMIGの定義 Objective-C パスカルPerl PHP Python
ルビー 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メーリングリスト(一般的にヘルプやパッチなどを入手するために使用されます)

  このプログラミングツール関連

admin

Share
Published by
admin

Recent Posts

健康安全研究所

Health_and_Safe…

3週間 ago

健康と安全のエグゼクティブ

Health_and_Safe…

3週間 ago

安全衛生委員会

Health_and_Safe…

3週間 ago

安全衛生当局

Health_and_Safe…

3週間 ago

2008年健康と安全(犯罪)法

Health_and_Safe…

3週間 ago