我新手湃窍,并且還是獨(dú)立開(kāi)發(fā)提岔,所以自己的代碼有很多都不符合規(guī)范,為了不被后來(lái)人罵死??【當(dāng)然最多的是為自己好】主巍,我覺(jué)得有必要了解下代碼規(guī)范冠息,所以今天上午就查了下網(wǎng)上的資料,總結(jié)了以下內(nèi)容
首先說(shuō)下為什么要代碼規(guī)范吧孕索,至少有以下幾點(diǎn):
1) 代碼可讀性提高了
2) 時(shí)間久了自己再維護(hù)可以一眼看懂方法的含義
3) 便于后來(lái)者看懂并理解你的代碼【據(jù)說(shuō)很多人在維護(hù)“前輩們”代碼的時(shí)候逛艰,都有種想砍人的沖動(dòng)= =】
4) 可以提高代碼的健壯性【這個(gè)不是瞎掰,且看后面介紹】
關(guān)于可讀性搞旭,你們看看我前后的代碼對(duì)比吧
乍一看覺(jué)得還行啊散怖,什么駝峰規(guī)則菇绵,方法名首字母大寫(xiě)都遵守了,但是這樣的代碼看久了會(huì)累镇眷,為什么咬最,不夠直觀!我必須要從頭看到尾才能看清楚每一個(gè)參數(shù)欠动,所以我就引用了第一條規(guī)則:如果一行有非常多的參數(shù),更好的方式是將每個(gè)參數(shù)單獨(dú)拆成一行永乌。如果使用多行,將每個(gè)參數(shù)前的冒號(hào)對(duì)齊。
所以我的代碼變成了這樣
首先說(shuō)這樣寫(xiě)的好處吧翅雏,第一,短沿猜,第二枚荣,齊碗脊,這樣看起來(lái)就很舒服啼肩,大家覺(jué)得呢?
這里用到的規(guī)則說(shuō)一下:
1. 方法名首字母小寫(xiě)衙伶,方法中要遵守駝峰規(guī)則【也就是單詞首字母大寫(xiě)】
2. 單行一般不能超過(guò)80列祈坠,提高可讀性【設(shè)置Xcode > Preferences > Text Editing > Show page guide,來(lái)使越界更容易被發(fā)現(xiàn)】
3. 方法參數(shù)取名應(yīng)該直觀易懂
4. 多個(gè)參數(shù)要拆行,以冒號(hào)對(duì)齊【如果第一個(gè)參數(shù)太短了矢劲,可以縮進(jìn)一下】
再講一下關(guān)于變量命名吧赦拘,只要記住一點(diǎn),不要擔(dān)心浪費(fèi)行寬芬沉,讓看代碼的人能看懂并立即理解更重要
錯(cuò)誤示例:
int? w;
int nErr;
正確示例:
int width;
int numErrors;
然后就是代碼的健壯性了躺同,好的代碼有助于提高運(yùn)行效率不是嗎?其中主要有以下幾點(diǎn):
1) 創(chuàng)建臨時(shí)對(duì)象時(shí)在同一行使用自動(dòng)釋放池丸逸,而不是后面單獨(dú)加一個(gè)release【MRC】蹋艺,可以有效避免意外刪除了release導(dǎo)致的內(nèi)存泄漏
例如:MyViewController *controller = [[[MyViewController alloc] init] autorelease];
2) 不要在構(gòu)造方法【init】中將成員變量初始化為 0 或者 nil;毫無(wú)必要 ,剛分配的對(duì)象黄刚,默認(rèn)值都是0捎谨,除了isa指針
3) 使用alloc init方法創(chuàng)建并初始化對(duì)象,不要使用new憔维,也沒(méi)必要重載它涛救,new會(huì)讓有關(guān)內(nèi)存分配的代碼審查更困難
最后就是文件注釋了,Xcode默認(rèn)新建一個(gè)類(lèi)之后它的文件注釋默認(rèn)是這樣的
在實(shí)際開(kāi)發(fā)中文件注釋如果寫(xiě)上的話(huà)是非常有用的检吆,每個(gè)文件的開(kāi)頭以文件內(nèi)容的簡(jiǎn)要描述起始,最好再簡(jiǎn)要描述一下功能,緊接著是作者,最后是版權(quán)聲明和/或許可證樣板程储。做個(gè)簡(jiǎn)單地示范咧栗,例如這樣:
這樣是不是就能看出來(lái)這個(gè)文件是干嘛的了?之后再維護(hù)的話(huà)是不是會(huì)更方便呢致板?說(shuō)起這個(gè)又要吐槽一下蘋(píng)果了交煞,本來(lái)這個(gè)注釋咱們是可以在Xcode ? Contents ? Developer ? Platforms ? iPhoneOS.platform ? Developer ? Library ? Xcode ? Templates?File Templates?Source?Cocoa Touch Class.xctemplate? 這個(gè)目錄下更改的,但是自從8之后就被鎖了斟或,所以還是自己封一個(gè)代碼塊吧素征,這個(gè)看個(gè)人需要我就不分享自己的代碼塊了??
先寫(xiě)到這里了,以后再看到什么有用的再添加萝挤,歡迎大家批評(píng)指正