Swift 2のドキュメントコメントの書き方(JavaDoc的なやつ)

公開日: : 最終更新日:2016/02/10 iPhoneアプリ開発

20160122-095132.jpg

コード補完時やoptionクリック時などに説明が出てくるようにする「ドキュメントコメント(Javaで言うJavaDocみたいなやつ)」の書き方について解説したいと思います!

    

スポンサード リンク

ドキュメントコメント(文書化コメント)

/** から始まるコメント、または /// で始まる行末までのコメントがドキュメントコメント(文書化コメント)として扱われます。

/**
 コメント
 */
/// コメント

    

段落

空白行によって段落を表現できます。

段落1

段落2

段落3

    

ソースコード

行の先頭に空白4つ、あるいは前後行を「“`(バッククォート3つ)」で囲うとコード行としてグレーの四角で囲われます。

``` 
let b = 234 
```

    

引数

以下のいずれかの書式で、引数に関する情報を書くことができます。

- parameter 引数1: 引数1に関する説明
- parameter 引数2: 引数2に関する説明
- parameters:
    - 引数1: 引数1に関する説明
    - 引数2: 引数2に関する説明

    

返り値

以下の様な書式で、返り値に関する情報を書くことができます。

- returns: 返り値に関する説明

    

エラー

以下の様な書式で、エラーがthrowされる場合の情報を書くことができます。

- throws: エラーがthrowされる場合の説明

    

見出し

行の先頭に#を置くことで、その行を見出しにできます。

# 見出し1

## 見出し2

### 見出し3

    

箇条書き

“-“, “+”, “*” を使うと箇条書きを表現できます。

- 項目1
- 項目2
- 項目3

    

太字・斜体

「**文字列**」「__文字列__」を使うと太字、「*文字列*」「_文字列_」を使うと斜体を表現できます。

**太字**

*斜体*

    

水平線

「—」または「***」で水平線を表現できます。

---

***

    

リンク

[リンク文字列](リンク先のアドレス) で、リンクを表現することができます。

[卵は世界である](http://egg-is-world.com)

    

実例

ドキュメントコメントを使った実例を以下に示します。

/// 割り算に関するエラー
enum DivideError : ErrorType {
    /// ゼロ除算
    case ZeroDivide
}


/**
 割り算を行う
 
 - parameter num1: 割られる数
 - parameter num2: 割る数
 
 - throws: 割る数が0だった場合にエラー
 
 - returns: 割り算の結果
 */
func divide(num1 num1: Int, num2: Int) throws -> Int {
    guard num2 != 0 else {
        throw DivideError.ZeroDivide
    }
    
    return num1 / num2
}

    

@akio0911はこう思った。

ドキュメントコメントをキッチリ入れておくと、コード補完時などに説明が出てくるのでコードが書きやすく&読みやすくなると思います!

ちなみにSwift 2のコメントに関しては以下の書籍に詳しく載っているので、気になる方は読んでみると良いかもです。

    

この記事が気に入ったら「いいね!」しよう

follow us in feedly

Feedlyで最新記事を購読

Twitterで更新情報をゲット!

LINEでご感想・ご要望お送りください!
(スマホでLINEを起動 > 友だち追加 > QRコード)

関連記事

I20160102-131507.jpg

Swift 2の文法が分かるオススメ本「詳解 Swift 改訂版」

Swift文法書の定番とも言える、荻原 剛志さんの「詳解 Swift」。 Swiftの文法をキ

記事を読む

20140818-141439.jpg

iPhoneアプリを作りたい開発初心者にまずはやってみて欲しい3つのこと

今日は、これからiPhoneアプリを作りたい開発初心者の方にやってもらいたいことを書いてみた

記事を読む

I20151122-213340.jpg

【入門本】詳細! Swift 2 iPhoneアプリ開発 入門ノート Swift 2 + Xcode 7対応

ソーテック社より「詳細! Swift 2 iPhoneアプリ開発 入門ノート Swift

記事を読む

I20160212-000722.jpg

Swiftにおけるセレクタ(Selector)について調べてみた

NSTimerなどを使う際、引数に「Selector」という型があるのですが、これがSwiftで

記事を読む

20160811-173801.jpg

【iOS】特定のセルがUITableViewの表示領域内に収まっているかどうかを調べる

特定のセルがUITableViewの表示領域内に収まっているかどうかを調べる方法を紹介します。


記事を読む

I20150709-234536.jpg

Swiftの文法をキッチリ学ぶのにオススメな本「詳解Swift」

解説が細かすぎるのでプログラミング未経験者や初心者にはオススメできませんが、Objective

記事を読む

20150327-131839.jpg

【Apple Watchアプリ】ボタン内の文字の先頭に画像を入れる方法【WatchKit】

Apple Watch向けのアプリを作るためのフレームワーク「WatchKit」。そのWatch

記事を読む

20150106-142403.jpg

Auto Layoutをコードで記述してビューを等間隔に並べる【Swift】

Auto Layoutをコードで記述して、ビューを等間隔に並べる方法について紹介します。ちなみに

記事を読む

iPhoneゲームを簡単に開発したいならこの本がオススメ!「Sprite Kit iPhone 2Dゲームプログラミング」

iPhoneゲームアプリを簡単に開発したいなら「Sprite Kit iPhone 2Dゲームプ

記事を読む

20160423-124300.jpg

【RxSwift】Hot変換オペレータの1つであるshareReplayを使ってみる

最近、RxSwiftについて勉強中です。 今回は、Hot変換オペレータの1つであるshareR

記事を読む

PAGE TOP ↑