Objective C方法命名約定

Question

對於使用給定documentID刪除數據庫中的文檔的“刪除”方法，什么名稱更好？

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

要么

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

Answer 1

您的命名約定完全取決於您，如Apple doc中所述嘗試並盡可能使用您的方法名稱描述，因此任何查看您的代碼（頭文件）的第三方都能夠快速了解​​該方法的內容確實。 從您發布的代碼中，您走在正確的軌道上。

看看這個文件。

Apple公約

Answer 2

看看Objective-C編程

• 方法名稱沒有前綴
• 方法應以小寫字母開頭
• 駱駝案例用於多個單詞
• 如果方法接受一個或多個參數，則方法的名稱應指示每個參數
• 錯誤應該是方法的最后一個參數

隨着和取決於你

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

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