iOS開発者のKotlin入門その5(コーディング規約)

botman3 Android
スポンサーリンク

はじめに

その4の続きです。コーディング規約について書きます。
基本的には下記参考
Kotlin スタイルガイド

コーディング規約

名前

ファイル名

大文字から始まるキャメルケースを用いる

クラス名

クラスとオブジェクトの名前は大文字から始まるキャメルケースを用いる

関数名

小文字から始まるキャメルケースを用いる

プロパティ名

プロパティ,ローカル変数は小文字から始まるキャメルケースを用いる
定数はアンダースコアで区切った大文字の名前を用いる(アッパースネークケース)

XML など元々大文字のやつはこんな感じで XmlHttpRequest になる

列挙型はアッパースネークケース

スペース

if, for, catch などの予約語の ( の左と ) の右に空白を1つ入れる

バイナリ演算子の両側

ラムダ式

メンバー参照

ドット区切り文字

範囲演算子 ..

コロン :

後ろは常にスペースを1つ入れる。
以下の場合に前にもスペースを1つ入れる。

  • 型とサブタイプを区切るために使うとき
  • 親クラスのコンストラクタか,同じクラスの異なるコンストラクタに処理を委譲するとき
  • 予約語 object の後
  • where

カンマ , の後には空白を1つ入れる

XML

ファイル名

すべて小文字で単語はアンダーバーで区切る(ローワースネークケース)

レイアウトファイル

id はローワースネークケース。
並び順は android:id を先頭に android:layout_***, android:** の順。style は最後。

参考:futurice/android-best-practices

リントツール

Android Studioには標準のリントツールがあるようで [Analyze] > [Inspect Code] で実行できる。
参考:lint チェックでコードを改善する

細かなルール設定

詳細なルールを設定するにはプロジェクトのルートディレクトリに lint.xml を配置する。

lint がサポートしている項目については lint --list コマンドで確認できる。

部分的にルールを無効化する

クラスファイルなどで無効化する場合、@SuppressLint アノテーションを使う。

XML で無効化する場合、tools:ignore 属性を使う。

複数のルールを無効化する場合はカンマ区切りにする

すべてのルールを無効化する場合

さいごに

これで Kotlin については一通り完成!次回からは Android 開発について書いていきます!

参考

コメント

  1. […] Android Studio 標準の [Analyze] > [Inspect Code] でいいと思います。 使い方詳細は下記 Android Studioには標準のやつ […]

タイトルとURLをコピーしました