開発

【swift】ドキュメントコメントについて

どうもこんにちは。iOSをメインに開発しているロッキーカナイです。
本日はドキュメントコメントについて書いてみたいと思います。

開発は一人でする事もあるでしょうが、だいたい複数人で行うでしょう。
「ここのメソッドってどんな事やっているの?」という会話を耳にする事もしばしば。時間をかけて見ればメソッドの動作を把握できるでしょうが時間が勿体無いですね。
であれば初めから誰が見ても分かり易く、コメントを残すようにするべきだと常日頃から思っております。
そしてXcodeにはQuik Helpという、メソッドなどの機能や引数の説明をメモする機能がありますので、それを使ってコメントを残してみてはいかがでしょうか?

そもそもSwiftのコメントは通常のコメントと今回紹介するドキュメントコメントの2種類があります。

通常のコメント

ドキュメントコメント

ドキュメントコメントではMarkdown記法が使用でき、スタイル指定やリンクの設定も可能です。

メソッドにドキュメントコメントを追加してみました。

上のドキュメントコメント時のQuik Helpの表示は以下の通りになります。

メソッド名をoption+クリックすると以下のようにも表示されます。

ドキュメントコメントには下記のようにもできます。

・***横線
・—横線
・斜体
・太文字
・リンク
・見出し

上のドキュメントコメント時のQuik Helpの表示は以下の通りになります。

メソッド名をoption+クリックすると以下のように表示されます。

今回はドキュメントコメントを紹介させて頂きました。
あなたが書いたコメントで、別のプログラマーの事故を防ぐという可能性だってあります。
コメントを残して、もっと見やすく、もっと事故の少ないコードを心がけていきましょう!

ABOUT ME
ロッキーカナイ
ロッキーカナイ
iOSをメインに、SwiftやObjective-C言語の開発をしてます。趣味は猫と戯れる事、PHPを使ったサイト作成やAndroidの開発もしております。ちなみに名前のロッキーカナイはよく昼飯を食べる所w