Swiftドキュメンテーションコメント（JavaDoc的なやつ）

更新 2015.09.27

Xcode 7 で記述のしかたが変わったようなので「Swiftのドキュメントコメント - Qiita 」を参照

---

JavaDoc的なやつ。

MyPlayground.playground

/**
* 箇条書き
    - aaa
    - aaa
    - aaa

* 番号付き
    1. aaa
    2. aaa
    3. aaa

* コード1
 // ほげほげ
 let hoge = Hoge()
 hoge.doSomething()


* コード2

    // ふがふが
    let fuga = Fuga()
    fuga.doSomething()


:param: 引数1
:param: 引数2
:returns: 戻り値
*/

• 「コード1」は、スペース1つ
• 「コード2」は、改行を入れて、スペース4つ
• 「*」「-」「+」は、どれもリスト表示のためのもので、同じものとして解釈される模様

参考

• Does Swift have documentation comments or tools? - Stack Overflow
• Swift Documentation - NSHipster