AppleDocの書式について

AppleDocはコメント内に書かれた記述を解析してドキュメントにします。コメントにする際にはスラッシュとアスタリスク2つ「/*」ではじまり、アスタリスクとスラッシュ「/」で終了したものを対象としています。また、単一行のコメントではスラッシュを3つのもの「///」を対象とします。

記述方法

解析対象となるコメントについてはMarkdown形式のような記述を行うことで、リスト、強調表示を使うことができます。また、ディレクティブと呼ばれる＠で始まるパラメータを指定することで、特定のコメントを記述することができます。

リストの表示は「-」か「+」で並べていくことで、リストかされていきます。また、順番付きリストは数字と「.」で指定することができます。

強調表示はアスタリスク「*」で囲むことにより記述できます。1つの時は「斜体」、2つの時は「太字」、3つの時は「斜体＋太字」となります。

* 斜体 *
** 太字 **
*** 斜体＋太字 **

タブかスペースを4つ入れることで、コードブロックとなります。

コメントにソースコードを記述する場合は、`(バッククォート) で囲みます。

コメント内にhttp:// 、https:// 、ftp:// 、file:// があればリンクに自動的に変換されます。

メソッドとプロパティの説明にはディレクティブを使用します。

メソッド、プロパティの返却値に関する説明をします。「@return 説明」のように記述します。

メソッドの引数の説明をします。「@param 名前説明」のように記述します。

例外の説明をします。「@exception 名前説明」のように記述します。