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 Conventions

Answer 2

查看Programming with Objective-C

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

依靠和取决于你

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

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