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コード)

関連記事

20150116-114410.jpg

プログラミング未経験者がSwiftの文法を学ぶのにオススメな本!「たのしいSwiftプログラミング」

楽しみにしていたSwiftの入門書「たのしいSwiftプログラミング」を読み終わったので、レビュ

記事を読む

20140721-170305.jpg

プロトタイピングのツールや手法を学べる「プロトタイピング実践ガイド」

株式会社インプレスさまより献本御礼。 プロトタイピング実践ガイド スマホアプリの効率的なデザイ

記事を読む

I20151119-165939.jpg

Swift 2.1に対応した本「詳解 Swift 改訂版」が出るぞ!

Swiftの文法に関する解説書の定番「詳解 Swift」の、Swift2.1に対応した改訂版「詳

記事を読む

20141031-150402.jpg

アップルのベータテストサービス「TestFlight」が正式公開

アップルが先週の木曜、ベータテストサービス「TestFlight」を正式に公開しました。 Te

記事を読む

I20150924-010943.jpg

Swift 2.0で追加されたOptionSetTypeがなかなか便利

Swift 2.0で追加されたOptionSetTypeプロトコルがなかなか便利なので紹介し

記事を読む

20140905-180905.jpg

英語苦手な人がSwiftを学びたいならこの本を読むといいよ!

アップルのWWDC2014で発表された、iOSおよびOS Xのためのプログラミング言語「Swift」

記事を読む

I20160126-141427.jpg

Swift 2でtoIntが使えない!unavailableエラーが出た時の対処方法

Swift 2でtoInt()を使うと、 'toInt()' is unavailable:

記事を読む

I20160124-111228.jpg

初心者がデザインを勉強するなら、まずこの本を読むといいかも

まず僕のスペックから話をすると、 アプリのコードを書いたり、ブログを書いたりしている

記事を読む

20160802-232454.jpg

【Xcode 7】メソッドがどこから呼びだされているかを調べる方法

Xcode 7で、メソッドがどこから呼び出されているのか調べる方法を紹介します!     方法

記事を読む

I20150808-104713.jpg

【Xcode】シミュレーターリストの表示がおかしくなった時の解決方法

Xcodeのシミュレーターリストの表示が、上のスクリーンショットのようにおかしくなってしまっ

記事を読む

PAGE TOP ↑