iOSが開発したOCネーミング仕様と符号化仕様(継続的な更新)

1676 ワード

成長を続ける毎日1編
ネーミング仕様
アップル自身のフレームワークで使われているアルパカの命名法は、統一を保つためにもアルパカの命名法です
キャメルCase:最初の単語は小文字で始まり、他の単語は大文字で始まる.アルパカ命名法(PascalCase):すべての頭文字が大文字です.
使用禁止_単語を分割し、システムネーミングの使用方法と一致するようにします.
  • クラス名、プロトコル名、アルパカを使用して
  • と命名
  • 定数:ここで定数とはマクロ(#define)、列挙(enum)、定数(const)などを指し、小文字「k」を接頭辞として用い、名称はアルパカ命名法
  • に従う.
  • メソッド
  • メソッド名とメソッドパラメータは、小文字で始まるアルパカ法を使用する同じ規則に従う.
  • メソッド名とパラメータは、できるだけ一言のように読みます.
  • メソッド名では「get」接頭辞は使用できません.
  • -または+と戻りタイプの間にスペースを残しますが、パラメータリストの間に間隔を置かないでください.
  • パラメータが多すぎる場合は、各パラメータが1行ずつ占めることを推奨します.たとえば、
    [person setName:@""
                age:1
          eyesColor:[UIColor redColor]];
  • 変数:
  • クラスメンバー変数、属性、ローカル変数、小文字の先頭を使用するアルパカ法、
  • クラスメンバー変数には、_myLovalVariable、_myInstanceVariable
  • などの名前の先頭に下線が付けられます.
  • 変数名の名称は、その用途を推測できるだけ記述的である.

  • コーディング仕様
  • メソッドの名前は長すぎるべきではなく、原則として100行
  • を超えない.
  • 類の実現ファイルの内容は1000行を超えてはいけない.500行以内の
  • が望ましい.
  • クラスのヘッダファイルは、他のカスタムヘッダファイル(システムファイルを許可)を導入しないで、@classで宣言するクラスを導入し、実装ファイルに必要なヘッダファイル
  • を導入します.
  • ビュークラスではコントローラオブジェクトを参照しないでください.コントローラオブジェクトと通信する必要がある場合は、プロトコル
  • を使用します.
  • 注釈規範、クラスのヘッダファイルと実現ファイルはすべて会社の要求によって作者、時間、クラスの主な機能、およびクラスの重大な更新ログを注釈しなければならない.小さな変更については変更箇所に名前、変更原因またはBugリンクなどの
  • を明記しなければならない.
  • mファイルにmethodが多い場合は、#pragma markタグを使用してメソッドをグループ化し、表示しやすい.
  • プロトコル、通知、KVO、コードブロックコールバックをできるだけ多く使用してクラスとクラス間の結合度
  • を低減する.
  • MVC仕様ではM層にC層、V層のクラスへの参照はできません.V層クラスにはC層ボックス、M層クラスへの参照は
  • ありません.
  • ローカル基本データ型の変数を初期化する必要があります.そうしないと、Boolが初期化しない場合、YESとNOが可能になるなど、予知できないエラーが発生します.intが初期化しない場合、0以外の値
  • である可能性があります.