objective-c - Objective C 方法命名约定

Question

对于删除具有给定 documentID 的数据库中的文档的“删除”方法，什么名称更好？

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

或者

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

Answer 1

您的命名约定完全取决于您，正如苹果文档中提到的那样，尝试尽可能描述您的方法名称，以便任何查看您的代码（头文件）的第三方都能够快速了解​​该方法是什么做。从您发布的代码来看，您走在正确的轨道上。

看看这个文件。

苹果约定

Answer 2

看看Objective-C 编程

• 方法名称没有前缀
• 方法应以小写字母开头
• 驼峰式大小写用于多个单词
• 如果方法采用一个或多个参数，则方法名称应指明每个参数
• 错误应该是方法的最后一个参数

取决于你

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

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