コーディング規約

Swiftコーディング規約@Wantedly が参考になったのでこれをそのまま使用している。 ちょっと驚いたのが定数が Upper Snake Case でなく接頭辞 k を付けた camelCase であることだ。 例えば let DEBUG_KEY = "hoge" でなく let kDebugKey = "hoge" となるということ。

先頭 k が最初奇妙に思えたが、しばらく Swift に触っていたら公式のライブラリなどもこの規則に従っているようなので正しく思えてきた。 よく考えたら Android も public でないフィールドには接頭辞 m を付けるという奇妙なルールを使用していたので、それと同じに思える。

JavaDoc 的なもの

Swift には JavaDoc 的なものが無いのかと思っていたのでコメントを適当に書いていたのだが、どうもあるようなのでそれに従うことにした。 Swift 2 のドキュメントコメントが参考になった。

三本スラッシュ /// で始めるとドキュメントコメントになるというのが結構便利に思った。 あとは markdown で書けばそのままドキュメントになるところとか、実にモダンだ。