You don't have javascript enabled. Good luck! :(

haddockのコメント形式

詳しい書式については以下のドキュメントを適宜参照してください。

Haddock 形式のコメントは非常に簡単です。

つまり、-- |-- ^ で始まるコメントが Haddock コメントということになります。慣習的に関数のコメントには -- | を使い、型のフィールドについては -- ^ を使っているように思います。

以下は公式のドキュメントに載っている例をまとめたものです。

これだけ知っていれば Haddock が書けると言って良いでしょう。強調のためのキーワードやモジュールのコメントなどはここでは紹介しないのでドキュメントをご参照ください。

@since メタデータは Yesod 関連のプロジェクトでは良く使われています。どのバージョンからこの関数が組み込まれたかをドキュメントに残すことができます。

実際に使ってみよう!

練習として minfree 関数に Haddock コメントをつけてみましょう。

まぁまぁ良いでしょう!ではドキュメントを生成してみます。

$ stack haddock --haddock-arguments --odir=haddock
スクリーンショット 2017-12-11 16.46.32.png
スクリーンショット 2017-12-11 16.46.32.png

失敗しました。流石に1行はちょっと読みづらいので、修正します。

修正は簡単で、改行したい場所に空行を挟むだけです。

スクリーンショット 2017-12-11 16.49.17.png
スクリーンショット 2017-12-11 16.49.17.png

それっぽくなりましたね!

haddock