關于代碼規范的問題

我新手,并且還是獨立開發,所以自己的代碼有很多都不符合規范,為了不被后來人罵死??【當然最多的是為自己好】,我覺得有必要了解下代碼規范,所以今天上午就查了下網上的資料,總結了以下內容
首先說下為什么要代碼規范吧,至少有以下幾點:

1) 代碼可讀性提高了
2) 時間久了自己再維護可以一眼看懂方法的含義
3) 便于后來者看懂并理解你的代碼【據說很多人在維護“前輩們”代碼的時候,都有種想砍人的沖動= =】
4) 可以提高代碼的健壯性【這個不是瞎掰,且看后面介紹】

關于可讀性,你們看看我前后的代碼對比吧

這是創建標簽欄之前的代碼

乍一看覺得還行啊,什么駝峰規則,方法名首字母大寫都遵守了,但是這樣的代碼看久了會累,為什么,不夠直觀!我必須要從頭看到尾才能看清楚每一個參數,所以我就引用了第一條規則:如果一行有非常多的參數,更好的方式是將每個參數單獨拆成一行。如果使用多行,將每個參數前的冒號對齊
所以我的代碼變成了這樣

這樣是不是整齊了?

首先說這樣寫的好處吧,第一,短,第二,齊,這樣看起來就很舒服,大家覺得呢?
這里用到的規則說一下:
1. 方法名首字母小寫,方法中要遵守駝峰規則【也就是單詞首字母大寫】
2. 單行一般不能超過80列,提高可讀性【設置Xcode > Preferences > Text Editing > Show page guide,來使越界更容易被發現】
3. 方法參數取名應該直觀易懂
4. 多個參數要拆行,以冒號對齊【如果第一個參數太短了,可以縮進一下】

再講一下關于變量命名吧,只要記住一點,不要擔心浪費行寬,讓看代碼的人能看懂并立即理解更重要
錯誤示例:
int? w;
int nErr;
正確示例:
int width;
int numErrors;

然后就是代碼的健壯性了,好的代碼有助于提高運行效率不是嗎?其中主要有以下幾點:
1) 創建臨時對象時在同一行使用自動釋放池,而不是后面單獨加一個release【MRC】,可以有效避免意外刪除了release導致的內存泄漏
例如:MyViewController *controller = [[[MyViewController alloc] init] autorelease];
2) 不要在構造方法【init】中將成員變量初始化為 0 或者 nil;毫無必要 ,剛分配的對象,默認值都是0,除了isa指針
3) 使用alloc init方法創建并初始化對象,不要使用new,也沒必要重載它,new會讓有關內存分配的代碼審查更困難

最后就是文件注釋了,Xcode默認新建一個類之后它的文件注釋默認是這樣的

其實我只想問問這個有什么卵用?

在實際開發中文件注釋如果寫上的話是非常有用的,每個文件的開頭以文件內容的簡要描述起始,最好再簡要描述一下功能,緊接著是作者,最后是版權聲明和/或許可證樣板。做個簡單地示范,例如這樣:

注明了不能更改了,更改小心翻臉哦

這樣是不是就能看出來這個文件是干嘛的了?之后再維護的話是不是會更方便呢?說起這個又要吐槽一下蘋果了,本來這個注釋咱們是可以在Xcode ? Contents ? Developer ? Platforms ? iPhoneOS.platform ? Developer ? Library ? Xcode ? Templates?File Templates?Source?Cocoa Touch Class.xctemplate? 這個目錄下更改的,但是自從8之后就被鎖了,所以還是自己封一個代碼塊吧,這個看個人需要我就不分享自己的代碼塊了??
先寫到這里了,以后再看到什么有用的再添加,歡迎大家批評指正

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容

  • iOS編程規范0規范 0.1前言 為??高產品代碼質量,指導廣大軟件開發人員編寫出簡潔、可維護、可靠、可 測試、高效...
    iOS行者閱讀 4,502評論 21 35
  • 代碼格式 使用空格而不是制表符 Tab 不要在工程里使用 Tab 鍵,使用空格來進行縮進。在 Xcode > Pr...
    small_Sun閱讀 1,378評論 1 3
  • 推薦文章:禪與 Objective-C 編程藝 前言 為??高產品代碼質量,指導廣大軟件開發人員編寫出簡潔、可維護、...
    WolfTin閱讀 2,812評論 0 1
  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,914評論 18 139
  • 終有一天,我會感激上帝為我關了美股這扇窗
    新興市場的小邏輯閱讀 116評論 0 0