MILLEN BOX

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

関数の説明文を書こう [Swift1.2]

(注意!!)
この方法はXcode6までの記載方法です!Xcode7以降の方は以下の記事を参照してください!

anthrgrnwrld.hatenablog.com

初アプリリリース完了の熱冷めやらぬ間に更新。

C言語とかのソースなどで、関数の前にその関数の説明文がコメントアウトされてついてたりするのを見ます。
こうゆうの、関数ヘッダとも言ったりするみたいです。

色々意見あると思うのですが、個人的には、作成した関数に関して、説明文を書いておくことは悪いことではないと思っております。(テスト設計とかで便利ですよね。多分。)

swiftで説明文を書く場合、何か作法とかあるのかな〜と調べてみると、やはりありました。

qiita.com

関数の前に以下のような形でコメント文を追加します。

    /**
    表示用にカウント数を10進数の桁毎に数値を分割する
    
    :param: count:カウント数
    :param: digitNum:変換する桁数
    :returns: digitArray:変換結果を入れる配列
    */
    func editCount(var count :Int, digitNum :Int) -> [Int] {
 
        var digitArray = [Int]()
        
        for index in 0 ... (digitNum - 1) {
            let tmpDec = pow(10.0, Double(digitNum - index - 1))
            digitArray.append(count / Int(tmpDec))
            count = count % Int(tmpDec)
        }
    
        return digitArray
    }

Xcodeにてこの書き方をすると利点があります。
関数の呼び出しの部分で option + Click すると、何と自分で追加した説明文が参照されるのです!
やった!

f:id:anthrgrnwrld:20150804203458g:plain

こんな風に自分の成果が見えるの、結構好きです。