IOS開發規範

命名規範

類命名

1)所有的類名,接口名(Protocol)均以大寫字母開頭,多單詞組合時,後面的單詞首字母大寫。
   類,接口名必須是有意義的,切忌使用中文拼音命名。
另外所有類都要加標緻前綴:“OP”

2)繼承自UIView的類以View結尾。
  例如:OperatorUsersInfomationView,LabelView等。

3)繼承自ViewController的類以viewController結尾。
例如:HomePageViewController,LoginViewController等。其他類推。

4)所有保存數據的實體以Model結尾。
  例如:UserModel

5)類別命名,與類命名相同,此外需要添加要擴展的類名和“+”
  例如:NSString+URLEncoding

方法命名

1)首字母小寫,之後每個單詞首字母大寫。
2)​留一個空格在-或+和返回類型之間,但參數列表裏的參數之間不要留間隔,每個冒號之前都必須有對該參數的說明詞
3)設置類變量的內容的方法應使用set作爲前綴,讀取變量的內容的方法應使用get作爲前綴,創建視圖用create作爲前綴。
4)方法中的參數:第一個參數名稱要從函數名稱中攜帶出來,參數名不要加下劃線等前綴。

 例:- (void)sendUserInfo:(NSDictionary *)userInfo Other:(NSString *)other;

變量

1)首字母小寫,之後每個單次首字母大寫。簡潔、準確的表示出變量作用。
2)成員變量不需要添加“_m”前綴
3)成員變量添加“_”前綴

常量

1)常量(預定義,局部常量等)使用小寫k開頭的駝峯法
 例:kInvalidHandle,kWriRerm
2)枚舉類型命名首字母大寫,之後每個單詞首字母都大寫,最後加“s”
3)枚舉變量使用枚舉類型去掉“s”作爲前綴,每個單詞首字母大寫,中間不允許加下劃線。
  例:typedef enum UIControlEvents {
      UIControlEventTouchDown,
      UIControlEventTouchUpInside
      }UIControlEvents;

圖片命名

1)使用英文,首字母大寫,之後每個單詞首字母都大寫
2)添加模塊名作爲前綴,避免衝突
3)圖片應該與類文件一樣,按模塊分組放置

分組命名

1)使用英文,首字母大寫,之後每個單詞首字母都大寫
2)每個分組使用模塊的名字
3)使用的開源庫統一放在“Lib”下的“3rd”分組夾中
4)使用的公共組件統一放在“common”分組下
5)視圖控制器放在“Controllers”分組下,並按模塊再分組

其他規範

1)操作符前後都要加空格
2)避免相同的代碼段在多個地方出現
3)語句嵌套層次不得超過3層
4)每個實現文件建議在500行以內,不能超過1000行,超過之後應考慮通過抽象類對代碼進行重構
5)及時刪除或註釋掉無用的代碼
6)UITableViewCell裏面的network client都要委託出來
7)點擊按鈕之後需要切換按鈕圖片,當這兩張圖片沒有關聯時(例如一張圖片相比另一張圖片有選中效果),不應該設置爲UIControlSelected
8)控件佈局使用相對座標
9)確定不使用的代碼應該刪除

註釋規範

1)文件都包含文件頭,要說明文件名、作者、創建時間、變更記錄
2)多人協作完成項目時,public接口的每個方法都應該添加關於函數,參數,返回值以及副作用的註釋 
3)當if語句的判斷條件複雜時,需要用註釋說明判斷內容 
4)接口類(繼承於BaseClient)的頭文件每個方法前都應該註明方法的作用
5)註釋可以採用’ /* */ ’和’// ’兩種註釋符號,涉及到多行註釋時,儘量使用’ /* */ ’。
6)對於一行代碼註釋,可放在前一行及本行上,不允許放在下一行,更不允許在一行語句中間加入註釋。

文檔結構規範

參閱醫評開發文件夾中的《源碼結構說明》文稿

發佈流程

1)修改項目中的服務器地址,改爲正式服務器;
2)修改Info.plist中的版本號,外部版本號看情況升,內部版本號,每次提交都要做一次增加;
3)連接已授權的手機,在XCode中選中,打包“Product”-->“Archive”;
4)打包進度條完成後,出現如下界面,點擊“Submit App Store”提交到Appstore;
5)提交成功後,到wiki中再提交一份對應版本的描述備案,要說明新版新增功能和遺留問題;
6)在git將代碼提交的主線,並打標籤註釋。

文本輸入框規範

控件屬性

1、手機號碼、體重和身高等數值型的輸入限定爲數字鍵盤

            UITextField.keyboardType = UIKeyboardTypePhonePad;

正則表達式

1、驗證手機號格式:^(0|86|17951)?(1[345678])\\d{9}$

2、驗證身份證格式:

  • 18位:^[1-9]\\d{5}[1-9]\\d{3}((0\\d)|(1[0-2]))(([0|1|2]\\d)|3[0-1])\\d{3}([0-9]|[xX])$
  • 15位,在身份證第7、8位加入“19”,最後位加“x”

3、限定中文輸入:[\u4e00-\u9fa5]

4、驗證郵箱規則:[A-Z0-9a-z._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,4}

多語言配置

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章