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

関連記事

20141228-232009.jpg

【Swift】as?演算子を使ったキャストでは結果がoptionalとなる

今日はSwiftのas演算子とas?演算子について解説したいと思います。as演算子について

記事を読む

20160730-172416.jpg

Auto Layoutで非表示にした部分を詰める(トルツメ)する方法

Auto Layoutを使って非表示にしたコントロールの部分を詰める(トルツメ)方法を説明します

記事を読む

20150327-131839.jpg

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

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

記事を読む

20141031-150402.jpg

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

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

記事を読む

20141210-164612.jpg

【Swift】Generated Header内にSwiftクラスの定義が記述されない場合の確認事項【Xcode6】

Swiftで書いたクラスをObjective-Cで使う際には、「Generated Header

記事を読む

20150116-114410.jpg

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

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

記事を読む

I20160130-110811.jpg

【解決】Redundant conformance of ‘NSDate’ to protocol ‘Comparable’エラーが出た時の対処方法

アプリ開発中に「Redundant conformance of 'NSDate' to pro

記事を読む

I20160126-141427.jpg

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

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

記事を読む

Auto LayoutやStoryboardの仕組みをしっかり理解できる!「UIKit徹底解説」

インプレスジャパン様より献本御礼。UIKit周りを中心に、「Auto Layout」「Story

記事を読む

I20150722-185359.jpg

【書籍】12のパターンで学ぶ本「iOSアプリ開発 AutoLayout徹底攻略」

     Auto Layoutの使い方について解説されている本「iOSアプリ開発 A

記事を読む

I20170521-225453.jpg
東京駅八重洲口の「羊肉酒場 悟大」で網焼きジンギスカンを頂きました!

ゆうせいさんと株式会社 大庄さんからご招待頂き、悟大withサッポ

I20170514-165235.jpg
iPhoneと連携できる体重体組成計「Withings Body Cardio」を使ってます

ジムに通い始めて体脂肪率が落ち始めたのをキッカケに、iPhoneと

I20170507-155440.jpg
【派手髪】ハーレイクイン風の髪色に染めてもらいました

2016年10月20日、ハーレイクイン風の髪色に染めてもらいました

I20170504-173110.jpg
【メンズネイル】東京・新宿のネイルサロンでターコイズのホログラムネイルしてもらった

ネイルネタが1年分くらい溜まっているので、ちょっとずつ書いていこう

I20170502-010117.jpg
SNUGGのライトニングケーブルが耐久性高し。8ヶ月使ってますが断線の気配なし!

iPhoneの充電&転送ケーブルであるLightningケーブルっ

→もっと見る

PAGE TOP ↑