2013-08-16 167 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