IOS团队编程规范

//表示对象行动的办法、履行性的办法

- (void)insertModel:(id)model atIndex:(NSUInteger)atIndex;

- (void)selectTabViewItem:(NSTableViewItem *)tableViewItem

//返回性的办法

- (instancetype)arrayWithArray:(NSArray *)array;

//参数过长的情况

- (void)longMethodWith:(NSString *)theFoo

rect:(CGRect)theRect

interval:(CGFloat)theInterval

{

//Implementation

}

//不要加get

- (NSSize) cellSize; //推荐

- (NSSize) getCellSize; //否决

//应用情态动词,不要应用do或does

- (BOOL)canHide; //推荐

- (BOOL)shouldCloseDocument; //推荐

- (BOOL)doesAcceptGlyphInfo; //否决

二、代码注释规范

优良的代码大年夜部分是可以自描述的，我们完全可以用代码本身来表达它到底在干什么，而不须要注释的帮助。

但并不是说必定不克不及写注释，有以下三种情况比较合适写注释：

公共接口(注释要告诉浏览代码的人，当前类能实现什么功能)。
涉及到比较深层专业常识的代码(注释要表现出实现道理和思惟)。
轻易产生歧义的代码(然则严格来说，轻易让人产生歧义的代码是不许可存在的)。

除了上述这三种情况，如不雅别人只能依附注释才能读懂你的代码的时刻，就要反思代码出现了什愦问题。

最后，对于注释的内容，相对于“做了什么”，更应当解释“为什么这么做”。

1、import注释

如不雅有一个以上的import语句，就对这些语句进行分组，每个分组的注释是可选的。

// Frameworks  
#import ;  
// Models  
#import "NYTUser.h"  
// Views  
#import "NYTButton.h"  
#import "NYTUserView.h"

2、属性注释

写在属性之后，用两个空格隔开

==例：==

@property (nonatomic, readwrite, strong) UIView *headerView; //注释

3、办法声明注释：

一个函数(办法)必须有一个字符串文档来解释，除非它：

非公开，私有函数。
很短。
显而易见。

而其余的，包含公开接口，重要的办法，分类，以及协定，都应当伴随文档(注释)：

以/开端
第二行是总结性的语句
第三行永远是空行
在与第二行开首对齐的地位写剩下的注释。

建议如许写：

/This comment serves to demonstrate the format of a doc string. 
 
  
 
Note that the summary line is	
			 3/10   首页 上一页 1 2 3 4 5 6 下一页 尾页	
			

　　推荐阅读
　　揭秘谷歌无人驾驶汽车的秘密世界：多种强大工具首次曝光
            
            《大年夜西洋月刊》本周刊文，揭开了 Alphabet 旗下无人驾驶公司 Waymo 的神秘面纱。在无人驾驶汽车的开辟过程中，Waymo 应用了多种强大年夜的对象，包含模仿对象 Carcraft、机密测试基地>>>详细阅读


本文标题：IOS团队编程规范
地址：http://www.17bianji.com/lsqh/36981.html
 1/2    1