読者です 読者をやめる 読者になる 読者になる

ツヨシのブログ

技術的な事とか日常の事とか徒然なるままに

AppleDocについて(その3)

AppleDocの書式について

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

記述方法

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

リスト表示

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

強調表示

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

* 斜体 *
** 太字 **
*** 斜体+太字 **

コードブロック

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

コードスパン

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

リンク変換

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

メソッドとプロパティの説明

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

@return

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

@param

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

exception

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

参照

http://gentlebytes.com/appledoc/ http://dev.classmethod.jp/smartphone/iphone/ios-appledoc-1/

詳細! Objective-C iPhoneアプリ開発 入門ノート Xcode5+iOS7対応

詳細! Objective-C iPhoneアプリ開発 入門ノート Xcode5+iOS7対応