【iOS開発】Objective-Cの自分用コーディング規約プラス
次開発するとき用のメモ。まずは下記の公開されているドキュメントを読む。
Google Objective-C Style Guide（英語）
Google Objective-C Style Guide（日本語訳）
[Apple Developer Center]Coding Guidelines for Cocoa（英語）
ここからは自分の中にあるコーディング規約。他のサンプルを参考にしながら。
- コメントは英語で。マニュアルも英語なので勉強だと思って手を抜かない。
- defineは「k」をprefixにしてキャメルケース
- クラス変数は「m」をprefixにしてキャメルケース。最後に「_」を付ける（上のコーディング規約に従うため）
- 自作クラスのメソッドの引数は「a」をprefixにしてキャメルケース。
- 「#pragma mark -」の前は２行空ける
- 「#pragma mark」を使って機能ごとに分けてコメントも付ける
- 「=」の場所は（できるだけ）合わせる
- ヘッダーファイルのクラス変数、プロパティ名、メソッド名の開始位置（アスタリスクの位置）を合わせる。アスタリスクは名前の直前。
- ヘッダーのdefineは「k」＋「（プロダクト名）」を先頭に付ける
- privateなプロパティやメソッドはカテゴリーの機能を使って、.mファイルの方に記述する。.hファイルは、そのクラスが外部に提供するプロパティやメソッドだけ。
- クラスファイルは全て「Classes」ディレクトリに配置して、xcodeのグループ機能で分かりやすいように分ける
- 言語ファイルは「jp.lproj」、「en.lproj」など２文字で。国名コード（wikipedia）
- xibファイルと対応するクラスは「*ViewController」。xibはないけど画面の制御するクラスは「*Controller」
- 自作クラスはプロジェクト共通の「Global.h」をimportする。
- 自作メソッドの直後はLOG_METHODを記述する。参考。
- 波括弧「{}」はクラス名、メソッド名、ifの同じ行に記述
もっとobjective-Cに慣れたらドキュメントにしていきたい。自分用だけど。
＜関連記事＞