MILLEN BOX

音楽好きの元組み込みソフトエンジニアによるプログラミング(主にiOSアプリ開発)の勉強の記録

関数の説明文を書こう Xcode7 対応版 [Xcode7.1]

また間が空きましたが久々の更新です。
ちょっとハマってしまったことがありまして間隔が空いてしまっています。
ハマるとブログに書きたいネタは増えるんだけど、ハマりの解消作業もしたい。というようなジレンマ中です。

今日もちょっと小ネタです。
以前関数の説明文についてこんな記事を書きました。

anthrgrnwrld.hatenablog.com

ルールに沿って関数ヘッダの説明文を書けば、すごくおしゃれで便利だよ〜という内容です。

で、時は流れまして、、、
本日、この記事の通りに関数の説明文を書いたんですが、option+Clickで関数の説明が思ったのと違う風になっていました。
具体的にはparameterやreturnsなどが分かれて表示されていたのが、Description内に全ての記述が記載されるようになってしまっていたのです。
ん〜??と思って調べたところ、やっぱりXcode7(Swift2?)で記述ルールに変更があったんですね。

qiita.com

自分ポイント

Xcode6までは

/**
説明

:param: a: 引数a
:param: b: 引数b
:returns: 返り値
*/

というような記載をしていました。
それがXcode7からは以下のような書き方に変更になった模様です。

/**
説明

- parameter a: 引数a
- parameter b: 引数b
- returns: 返り値
*/

また何とMarkdown記法にも対応しています!

具体的な関数を例として、以下に使用例を書いておきます。

    /**
    sizeとcenter座標の指定からorigin座標を算出する(_=rectを算出する_)関数
     
    - parameter size:算出するrectのsize
    - parameter center:算出するrectのcenter座標
    - returns: sizeとcenterから算出されたorigin座標を含めたrectを返す
    */
    func makeRectFromSizeAndCenter(size :CGSize, center :CGPoint) -> CGRect {
        
        let origin = CGPoint(x: center.x - (size.width) / 2, y: center.y - (size.height) / 2)   //sizeとcenterから座標位置を特定
        let rect = CGRectMake(origin.x, origin.y, size.width, size.height) //blurView用Rect
        
        return rect
    }

この書き方で今まで通り、関数の呼び出しの部分で option + Click すると、自分で追加した説明文が参照されるようになりました!
Markdown対応なので"=rectを算出する"の部分が斜字体になっているのもポイントです。

f:id:anthrgrnwrld:20151112075009g:plain

やっぱり説明文をちゃんと書いていると落ち着きますね。