Loading article…
| 開発者 | サイモン・マーロウ |
|---|---|
| 初回リリース | 2002年5月1日 |
| 安定版リリース | 2.25.0 [1]
/ 2021年3月2日 |
| リポジトリ |
|
| 書かれた | ハスケル |
| オペレーティング·システム | クロスプラットフォーム |
| プラットフォーム | x86、PowerPC |
| タイプ | ドキュメント生成 |
| ライセンス | BSDスタイルのライセンス |
| Webサイト | http://haskell.org/haddock/ |
Haddockは、Haskell用の無料かつポータブルな[2] コマンドライン プログラムドキュメント ジェネレータです。
ソフトウェア
IDoc [3]、HDoc [4]、Doxygen [5]の影響を受けています。注釈付き Haskell (ドキュメントはコメントに埋め込まれています)ソースファイルからハイパーリンクされた HTMLファイルを生成し、追加情報は型注釈から抽出されます。SGML でのドキュメント生成は部分的にしかサポートされていません。[6] darcsやCabalと組み合わせて使用されることが多いです。Glasgow Haskell Compiler ( GHC )に依存しており、GHC に含まれる Haskell 用の HsParser ( Happyで記述)パーサーの修正版を使用しています。[6]軽量なマークアップは IDoc に基づいています。[6] Haddock はHaskell Platformに含まれています。
これはGHC、Gtk2Hs、HTkプロジェクト[7]やxmonadでも使用されています。[要出典]
以下は Haddock マークアップの例です。
-- | これは「Prelude」の (*) 演算子を使用する'square' のドキュメントです。 -- これは @x@ 引数をそれ自身に対して乗算します。square :: Integer -> Integer square x = x * x
参考文献
- ^ “リリース 2.25.0”. 2021年3月2日. 2021年3月25日閲覧。
- ^ Haddock は POSIX準拠のオペレーティング システムおよびMicrosoft Windowsで動作します。
- ^ 「IDoc マニュアル - インストール」。www.cse.unsw.edu.au。
- ^ 「Armin Größlinger のホームページ」www.fmi.uni-passau.de。
- ^ 「1.3. 貢献者」. haskell.org .
- ^ abc 「Haddock: Haskell ドキュメント ツール」Wayback Machineに 2006-10-11 にアーカイブ-(Simon Marlow 著、ACM SIGPLAN Haskell ワークショップの議事録、2002 年、PDF )
- ^ 「Haddock は、新しい階層型 Haskell ライブラリのドキュメント作成に使用されています。GHC の最新リリースに同梱されているライブラリ用に生成されたドキュメントは、こちらにあります。Gtk2Hs プロジェクトは、リファレンス ドキュメントの作成に Haddock を使用しています。HTk プロジェクトは、ライブラリ ドキュメントの生成に Haddock を使用しています。」Haddock ホームページより。
外部リンク
- 公式サイト