《IOS編碼及注釋規(guī)范.doc》由會(huì)員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在教育資源-天天文庫(kù)。

1、個(gè)人收集整理勿做商業(yè)用途IOS開(kāi)發(fā)編碼及命名規(guī)范個(gè)人收集整理勿做商業(yè)用途目錄１、目的32、適用范圍?33、編碼規(guī)范33．１、文件?33.2、注釋33.３、編碼排版格式?５3．4、命名規(guī)范?6３.4.1、保留字?６3.4.2、方法7３.4.3、變量73.4.４、常量83.4.5、類(lèi)９３．4．6圖片命名９3.5、修改規(guī)范?93.5.２、新增代碼行?９3．5．2、刪除代碼行?1０3.5.3、修改代碼行１0３.5.4、其他規(guī)范10個(gè)人收集整理勿做商業(yè)用途1、目的統(tǒng)一規(guī)范ＸCode編輯環(huán)境下Ｏbjectiｖe-C的編碼風(fēng)格和標(biāo)準(zhǔn)２、適用范圍適用于所

2、有用Obｊeｃｔｉve-Ｃ語(yǔ)言開(kāi)發(fā)的項(xiàng)目。3、編碼規(guī)范3.１、文件1)　項(xiàng)目文件必須使用一個(gè)有意義的名字一般用bunｄｌeId最后一位如lｅｎdｅr.xｃodeproｊ’。2)公共文件統(tǒng)一命名為’Ｐｕblic.h’。任何文件的命名盡量不要以中文命名。３)對(duì)于文件的目錄要按如下結(jié)構(gòu)創(chuàng)建:-Docｕmｅｎｔ(文檔所在路徑)-Heｌp（幫助文件所在路徑)-圖片等資源文件放在單獨(dú)的目錄與組(Ｇrｏup)中,如Ｉmａgｅs。-所有的viｅw放在單獨(dú)的組(Gｒoｕp)中，如CustoｍView。-所有的ｖｉewＣｏｎtrolｌｅr放在單獨(dú)的組中,如v

3、ｉeｗＣontrolｌeｒs?！?引用外部文件或者某個(gè)單獨(dú)的功能時(shí),放在單獨(dú)的組中,例如：程序中使用了coｖerfloｗ功能,引用openflow的文件時(shí)，將其全部文件放在oｐｅnFlｏw這個(gè)組中。其view和viewcontrolｌｅr等文件的組織不受上面所規(guī)定的影響?！?)bunｄｌeＩd命名：公司的域名反過(guò)來(lái)最后一位是項(xiàng)目名稱(chēng)一般越短越好　舉例:com.ppｄaｉ.*(coｍ.ｐpdai.lｅｎder)3．２、注釋1）注釋可以采用’/**/　’和’　//’兩種注釋符號(hào)，涉及到多行注釋時(shí),盡量使用’／**/’。2)對(duì)于一行代碼的注釋可

4、放在前一行及本行上，不允許放在下一行,更不允許在一行語(yǔ)句的中間加入注釋。個(gè)人收集整理勿做商業(yè)用途3)　單元文件的文件頭注釋說(shuō)明應(yīng)按如下格式：/／//　文件名／/工程名／///　Creａt(yī)edby創(chuàng)建者on日期.//?。茫飌yrｉｇhｔ　201０　xｘｘ有限公司.Allrｉｇhtsresｅrved．／／//系統(tǒng)名稱(chēng)：//功能描述://修改記錄:(僅記錄功能修改）//　張三　2012－02-０２　創(chuàng)建該單元/／　小明　20１0-03－02增加本地點(diǎn)單功能。/／4)方法前面的注釋遵循以下格式：如果某項(xiàng)沒(méi)有,則以N/A表示例如：　/＊＊＊＊***

5、************＊＊**********＊******＊*****＊*＊****＊******　　　　函數(shù)名稱(chēng)：－(BＯＯL)showFｉveＡndＳixSｔａiｒRoｏmＣoｕntByＳtａt(yī)u　　函數(shù)描述:顯示特定狀態(tài)下五樓和六樓的房間數(shù)　　輸入?yún)?shù)：(ＮSSｔring　*)ｓtatｕ:某狀態(tài)。輸出參數(shù):（ｉnt*)roomＣounｔ:該狀態(tài)房間數(shù)量。返回值:BＯOL：操作是否成功。　　　*＊*＊＊＊**********＊*＊＊＊*****＊*******＊＊*＊***＊*＊＊****＊******＊＊/-（voｉd)sｈow

6、FiveAndSｉxStairRoomCｏｕntByStａｔu:(NSStrｉnｇ*)ｓtatｕ　ｒoomＣｏunt:（int?。?＿rｏｏmCount；或／＊*＊*＊****＊****＊*******＊****＊＊****＊*＊*＊**＊*＊*******＊＊**＊＊**　函數(shù)名稱(chēng):-(NSUIｎtegeｒ)showFiveＡnｄSiｘＳtaｉrＲoｏｍＣoｕｎt　函數(shù)描述：顯示五樓六樓的房間數(shù)?！≥斎?yún)?shù)：N/Ａ輸出參數(shù):N／A返回值:NSUIｎteger：房間數(shù)量。　　　*******＊**＊*＊＊＊＊*＊**＊********＊*

7、****＊＊***＊**********＊＊***＊*/-(NSUIntegｅr）ｓhoｗFiｖｅAｎdSixStairRoomCｏunt5)不必每行都加注釋?zhuān)?~10行左右的段落做注釋要好于每行都做注釋,顯而易見(jiàn)的代碼不加注釋。例如:iｆ（！returnValuｅ）　／/調(diào)用登錄過(guò)程失敗　　?無(wú)用的注釋{個(gè)人收集整理勿做商業(yè)用途　　　NSLog(@”登錄失敗”);｝３.3、編碼排版格式１)　代碼的縮進(jìn)應(yīng)使用空格（ＳＰＡＣE)，不能使用制表符（ＴＡＢ）,并且縮進(jìn)以2個(gè)字符為單位。2)中括弧的每一個(gè)括弧在源程序中要單獨(dú)占一行。例如　//不

8、正確用法　　for　(iｎt　i　=0;ｉ<　10；i++)　{?……　　}／/正確用法ｆor　(iｎt　i=0;ｉ<10;i＋+){……}3）　空格的使用　　a)　關(guān)鍵字與其后的表達(dá)式之間要