2013-08-16 166 views
1

對於使用給定的documentID刪除數據庫中的文檔的「delete」方法,什麼名稱更好?Objective C方法命名約定

1) -(void) deleteDocumentWithID:(NSString *) documentID error:(NSError **)error;

2) -(void) deleteDocumentByID:(NSString *) documentID error:(NSError **)error;

+3

或具有ID是你(我會喜歡withID)。但是參數應該是'NSString *'和'NSError **' – Mario

回答

2

看一看Programming with Objective-C

  • 方法名稱沒有前綴
  • 方法應該以小寫字母
  • camel case開始被用於多個單詞
  • 如果一個方法需要一個或多個參數,方法名稱應爲 美食各參數
  • 錯誤應該是方法

enter image description here

通過最後一個參數,並取決於你

-(void) deleteDocumentWithID:(NSString *) documentID error:(NSError **)error; 

-(void) deleteDocumentByID:(NSString *) documentID error:(NSError **)error; 
+0

從英語語法的角度來看,在這種情況下「By」或「With」更好? – zyxel

2

命名約定是完全取決於你,如蘋果文檔嘗試提及,並儘可能描述你的方法名稱,以便任何第三方查看您的代碼(頭文件)將能夠快速瞭解​​該方法的用途。從你發佈的代碼你是在正確的軌道上。

看看這個文件。

Apple Conventions

+0

類型的參數。+1 :) – abbood