Objective-C代碼規範(2016.1.12王彬)

来源:http://www.cnblogs.com/wangbinios/archive/2016/01/12/5123735.html
-Advertisement-
Play Games

Objective-C代碼規範


 

第一話   官方代碼規範

Objective-C 編碼規範,內容來自蘋果、谷歌的文檔翻譯,自己的編碼經驗和對其它資料的總結。

概要

Objective-C 是一門面向對象的動態編程語言,主要用於編寫 iOS 和 Mac 應用程式。關於 Objective-C 的編碼規範,蘋果已經有很好的總結:

本文主要整合了對上述文檔的翻譯、作者自己的編程經驗和其他的相關資料,為公司總結出一份通用的編碼規範。

網站:http://www.cocoachina.com/ios/20150508/11780.html

 

第二話  自己的一些經驗之談

類(Class)命名原則

  就拿“NSMutableArray”來說 

  NS --- 首碼(Prefix)我的理解是表示類所屬的“包”,這裡的NS就表示的是Cocoa的基礎類庫,取公司名項目名什麼的。(NS是NextStep公司的簡寫,裡面的淵源就不細說了- -)首碼的意義就在於比較直觀的劃分了類的所屬和範圍。像Cocos2d里的首碼就是CC,box2d裡面是B2,UserInterface->UI,CoreFoundation->CF,CoreGraphics->CG。如果我也能寫一個開源架構或模塊的話,我應該會取“SY”或是“Sunny”吧 :)
  MutableArray --- 類名,簡短明確的形容類所表示的內容。首字母大寫,駝峰標示。另外值得註意的是,由於NSMutableArray是NSArray的擴展子類,本質上形容的都是Array,所以應該保留父類的識別字樣“Array”,但NSObject到NSArray不應該起名成NSArrayObject,也是避免了語義的重疊。

 

成員變數與屬性存取器(Accessor)命名原則

  這也是讓我糾結了挺久,一直不懂為什麼很多代碼裡面類成員變數出現了下劃線"_",而屬性存取方法@property聲明時不加下劃線,實現時@synthesize又令兩個名字相等。 

@interface SunnyTest : NSObject 
{
    NSArray * _array;  
}
@property (nonatomic,retain) NSArray * array;
@end

 

@implementation SunnyTest
@synthesize array = _array;
@end

  這樣做的原因很簡單,就是不暴露實例的成員變數,外界只能用@property聲明的存取名來訪問成員變數,所以就用下滑線加以區分。

  但在類內方法訪問成員變數時就直接使用帶下劃線的名字,個人認為不要用self.xxxxx來使用,因為使用存取器本來就是對外的,在內部使用可能會造成一些不必要的錯誤,比如:

self.array = [[NSArray alloc] init]; //記憶體泄露

  這時就會造成記憶體泄露,因為[[NSArray alloc] init]生成NSArray對象之後賦值給self.array,由於array的存取方法中包含retain,這會使retainCount變成2,而實際應該是1,記憶體泄露且很難發現。

  改成這樣的寫法也是蘋果官方推薦的。

_array = [[NSArray alloc] init];

 

方法(Method)起名規則

  一個規範的方法讀起來應該像一句完整的話,讀過之後便知函數的作用。執行性的方法應該以動詞開頭,小寫字母開頭,返回性的方法應該以返回的內容開頭,但之前不要加get。

 

- (void)replaceObjectAtIndex:(NSUInteger)index withObject:(id)anObject;
+ (id)arrayWithArray:(NSArray *)array;

  如果有參數,函數名應該作為第一個參數的提示信息,若有多個參數,在參數前也應該有提示信息(一般不必加and)

  一些經典的操作應該使用約定的動詞,如initWith,insert,remove,replace,add等等。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 通過Product->Analyze來進行靜態分析可以使用Quartz2D的函數來指定retain和release一個對象。例如,如果創建了一個CGColorSpace對象,則使用函數CGColorSpaceRetain和CGColorSpaceRelease來retain和release對象。也可...
  • CGRect rect;rect = self.labelInfo.frame;//UILabel高度自適應rect.size.height = [self.labelInfo.text boundingRectWithSize:CGSizeMake(rect.size.width , 8000)/...
  • Quartz2D繪圖主要步驟:1.獲取【圖形上下文】對象 ——(拿到草稿紙)2.向【圖形上下文】對象中添加【路徑】2.1 拼接路徑(畫內容)2.2 添加路徑到上下文(把內容放在草稿紙上)3.渲染 ——(把【圖形上下文】中的圖形繪製到對應的設備上)(根據草稿紙上的內容顯示出來東西)關鍵方法: 1 //...
  • Quartz2D須知:(1)Quartz2D是蘋果官方的二維繪圖引擎,同時支持iOS和MacOSX系統(跨平臺,純C語言的)(2)Quartz2D的API是純C語言的(3)Quartz2D的API來自於CoreGraphics框架 (4)數據類型和函數基本都以CG作為首碼CGContextRef.....
  • 想法: 有的人喜歡用qq,有的人喜歡用微信,總而言之,是一個通信工具。 qq上有很多群,微信上有很多群,每個群挨個瀏覽一遍、回覆,還容易回覆錯誤,前言不接後語。 有沒有可能在一個界面,接受所有信息,並且回覆 設想: 1、模擬qq或微信登陸 2、內部讀取信息列表 3、按群分好組 4、瀏覽或者回覆...
  • 在- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath這個方法中通過indexPath找到對應的cell,可以用UITableViewCell*cell = [table...
  • 命令行更新(安裝)步驟1. $ sudo gem update system // 先更新gem,國內需要切換源2. $ gem sources remove https://rubygems.org/3. $ gem sources a https://ruby.taobao.org/4. $ ....
  • 分三部分實現,在drawrect方法里畫出灰色背景,根據pageCount創建對應個數的dotView放置在對應位置,並隱藏,創建一個CAShapeView類型的layer,根據scrollView的偏移量 構建貝塞爾曲線,畫出紅色線條,以及形變的大圓。大圓的形變以及構建思路:(圖引用自:http:...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...