IOS編碼安全規(guī)范

1、. 移動端-ios編碼安全規(guī)范一、 命名1、 bundle id命名：規(guī)則：采用反域名命名規(guī)則，全部使用小寫字母。一級包名為com，二級包名根據(jù)應(yīng)用進(jìn)行命名。2、 類命名：1) 類命采取駝峰命名規(guī)則，即首字母必須大寫，如果為詞組，則每個單詞的首字母必須大寫，類名只能使用名詞或名詞詞組，力求類名簡單，不允許出現(xiàn)冗余的單詞。2) 繼承自uiview的類以view結(jié)尾。3) 繼承自viewcontroller的類以viewcontroller結(jié)尾。4) 保存數(shù)據(jù)的實(shí)體以model結(jié)尾。3、 方法的命名：規(guī)則：方法名第一個單詞是一個動詞，其首字母小寫，其后的所有單詞首字母大寫。如：public voi

2、d threadrun()1) 類中常用方法命名：l 類的獲取方法如果返回值為單個值，一般在頭部加上單詞“get”。如果返回值是數(shù)組或列表，要在頭部加單詞“find”精品.如：public string getusername() 、public list findfriends()l 類的設(shè)置方法在被訪問字段名的前面加上前綴 set如：public void setname（string name）l 類的布爾型判斷方法一般要求方法名使用單詞 is或has 做前綴如：isnetworkconnected（）l 構(gòu)造方法應(yīng)該用遞增的方式寫。參數(shù)個數(shù)少的在前4、 變量命名規(guī)則：第一個單詞首字母必

3、須小寫，往后的單詞需要符合駝峰命名規(guī)則，即第一個字母大寫。變量名盡可能的使用名詞或名詞詞組。同樣要求簡單易懂，不允許出現(xiàn)無意義的單詞。如：string username 避免使用全局變量，如果用到必須加前綴 pub_,同時需要在變量名體現(xiàn)其類型。5、 成員變量命名與變量命名一樣，在private字段前加上字母“m”。6、 控件變量命名規(guī)則：一般的變量命名后加上控件名稱iboutlet uilabel *usernamelabel;7、 常量命名：精品.規(guī)則：必須全部大寫，單詞間用下劃線隔開。如：map_key8、 異常命名：規(guī)則：自定義異常首字母大寫，以 exception 為結(jié)尾。如：app

4、exception9、 資源命名：項(xiàng)目中所使用的所有資源命名必須以全部單詞小寫，單詞間以下劃線分割，加前綴區(qū)分。名稱功能btn_xx_normal按鈕正常情況下的效果btn_xx_press按鈕點(diǎn)擊下的效果bg_head背景圖片使用bg_功能_說明def_search_cell默認(rèn)圖片使用def_功能_說明icon_more_help圖標(biāo)圖片使用icon_功能_說明seg_list_line具有分割特征的圖片使用seg_功能_說明sel_ok選擇圖標(biāo)使用sel_功能_說明二、 注釋精品.1、 頭文件注釋：所有的源文件都應(yīng)該在開頭有一個注釋，其中列出頭文件的相關(guān)描述、作者、以及對應(yīng)的版本信息。/

5、*! header 頭文件名稱 abstract 關(guān)于這個源代碼文件的一些基本描述 author作者 version 1.00 2012/01/20 creation (此文檔的版本信息：版本號+創(chuàng)建時間) */2、 類注釋每一個類都要包含如下格式的注釋，以說明當(dāng)前類的功能等。/*! class 類名 abstract 這里可以寫關(guān)于這個類的一些描述。 */3、 枚舉注釋每一個枚舉都需要包含相對應(yīng)的enum描述，以及每個枚舉值對應(yīng)的含義。/*! enum 枚舉名稱 abstract 關(guān)于這個enum的一些基本信息 constant 各個對應(yīng)值得含義，如： okbutton 對應(yīng)的是ok按鈕的t

6、ag */精品.4、 協(xié)議注釋協(xié)議需要注明是哪個類對應(yīng)的protocol，以及自身的相關(guān)描述。/*! protocol 協(xié)議名稱 abstract 這是哪個類的protocol discussion 具體描述信息 */5、 方法注釋包括當(dāng)前方法的用途，當(dāng)前方法參數(shù)的含義，當(dāng)前方法返回值的內(nèi)容和對應(yīng)的錯誤參照。/*! method 方法名 abstract該方法的一些簡要描述 discussion該方法的具體使用方式，需要注意的地方，如果你是設(shè)計(jì)一個抽象類或者一個共通類給給其他類繼承的話，在這里需要具體描述一下怎樣使用這個方法。 param text參數(shù)列表 param error 錯誤參照 r

7、esult 返回結(jié)果 */6、 屬性注釋/*!精品. property 屬性名稱 abstract 該property的一些基本描述。 */7、 類別注釋/*! category 類別名稱 abstract 哪個類的類別 */三、 代碼風(fēng)格1、 縮進(jìn)規(guī)則：禁止使用tab進(jìn)行縮進(jìn)，縮進(jìn)為4個空格2、 .h文件空行可以使用空行的情況： 文件說明與頭文件包含(#import)之間類聲明跟接口聲明之間。 頭文件包含(#import)與class之間 interface與class之間 頭文件內(nèi)，空1行開始寫成員對象。 頭文件外，空1行開始寫屬性。 屬性與方法之間。 方法與end之間。 如果需要聲明pr

8、otocol，空2行接著寫。通常protocol寫在end后面，但是聲明在interface之前精品.。 方法與方法之間空1行。3、 .m文件空行 文件說明與頭文件包含(#import)之間。 頭文件包含(#import)之間。 implementation和synthesize之間。 synthesize與方法之間。 變量聲明后需要空1行。 各功能塊之間。 #pragma mark 與方法之間。4、 空格 關(guān)鍵字與其后的表達(dá)式之間需要加空格。 單目操作符不應(yīng)與操作數(shù)分開。 除,外，其它雙目操作符應(yīng)與它們的操作數(shù)用空格隔開。 .h中協(xié)議前面有一個空格。 .h中成員聲明時，類型與變量之間有至少1

9、個空格。*號靠近變量，不靠近類型。 property后留1個空格，（）里面，逗號緊跟前一變量，與后一變量之間留1 個空格。（）外面，先留1個空格，再聲明屬性。 方法的+，-后面與（）。 返回類型與*之間留1個空格，方法參數(shù)中返回類型與*之間留1個空格 在多參數(shù)方法中，每個參數(shù)后面都有1個空格。精品. switch.case 語句，代碼塊需要留4個空格。 if語句嵌套，內(nèi)部if語句需要留4個空格。5、 importimport語句引入的次序如下： ios imports 第三方庫 自定義.h文件在每組內(nèi)部按字母排序，大寫字母排在小寫字母的前面。每個大組之間應(yīng)該空一行。6、 log規(guī)則：統(tǒng)一使用自

10、定的log服務(wù)，不直接使用系統(tǒng)自帶。7、 語句每行只能有一個語句每行代碼最多不得操作100個字符。8、 標(biāo)準(zhǔn)大括號風(fēng)格大括號不單獨(dú)占用一行；它們緊接著上一行書寫。9、 控制語句1) if語句判斷中如果有常量，則應(yīng)將常量放在判斷式的右側(cè)，如if (a b)如果if語句成立的邏輯只有一句，則應(yīng)該將其放在if同一行或用括起來。如：if (index 0) 精品.if (index 0).2) while語句循環(huán)語句中不允許出現(xiàn)表達(dá)式。如while（i documents.getcount()）四、 修改規(guī)范1. 新增代碼行新增代碼行的前后應(yīng)有注釋行說明。 /修改人，修改時間，修改說明 新增代碼行 /修改結(jié)束2. 刪除代碼行刪除代碼向的前后用注釋行說明 /修改人，修改時間，修改說明 要刪除的代碼行(將要刪除的語句進(jìn)行注釋) /修改結(jié)束3. 修改代碼行修改代碼行以注釋舊代碼行后再新增代碼行的方式進(jìn)行。/修改人，修改時間，修改說明 /修改前代碼行開始 精品./修改前代碼行 /修改前代碼行結(jié)束 /修改后代碼行開始 修改后代碼行 /修改結(jié)束五、 嚴(yán)禁出現(xiàn)的情況1、 永遠(yuǎn)不要有空的catch語句。替代方案：向方法的調(diào)用者拋出異常、或者抽象級別拋出新異常。2、 避免在一條語句