Swiftにドキュメンテーションコメントをつける

Xcode / Swiftはドキュメンテーションコメントに対応しているので、例えば以下のようにすると、サジェスト時などに説明文が表示されて便利です。

/**
 メソッドhogehogeの説明

:param: id アイディーを渡します
*/
func hogehoge() {
...

この説明文を表示したい場合、サジェスト機能に出てきた時に確認するか、あるいはOptionボタンを押しながらメソッドをクリックすることで表示が可能です。

参考

• Swiftでヘッダドキュメント – tsntsumi’s NOOTO