1 / 13
文档名称:

研发体系(iOS开发规范).doc

格式:doc   大小:39KB   页数:13页
下载后只包含 1 个 DOC 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

研发体系(iOS开发规范).doc

上传人:文库旗舰店 2019/10/6 文件大小:39 KB

下载得到文件列表

研发体系(iOS开发规范).doc

文档介绍

文档介绍:IOS开发规范文件编号:XXXX-SE-Dev-XXX版本号: 编写人: 审核人:   适用对象该规范适用于××。版本记录【此部分要记录该文档形成过程中的历次版本变更过程及变更的内容】                                相关文档名词解释规范正文备注::能够由浅入深的解释主题,成员可以读懂,并能够依据规范进行简单开发。:语言不要白话,尽量使用业界公认的术语,专业术语需要在名词解释中给予详尽的阐述。:章节分类要清晰,最好不要超过4层。:提倡使用示例解释问题,但要求示例精干,并辅以层次描述,不要只Copy源代码。:要包含基本内容、技术架构。:缩写统一使用大写,全称使用Pascal命名法则,并且前后一致。:规范中可以对API进行必要的解释,但目的是为了说明特定的问题,详尽的API必须提供专门的规范。:●尽量减少错别字,善于使用“Word提供的拼写和语法检查工具”。●尽量使用图来说明问题。(1)指针"*"的位置如:NSString*varName;(2)缩进1个TAB=4个space,采用4个space的字符缩进(3)每行的长度每行最多不得超过100个字符,通过“Xcode=>Preferences=>TextEditing=>勾选ShowPageGuide/输入100=>OK”来设置提醒(4)方法的声明和定义在-OR+和返回值之间留1个空格,方法名和第一个参数间不留空格。如:-(void)doSomethingWithString:(NSString*)theString{...}当参数过长时,每个参数占用一行,以冒号对齐。如:-(void)doSomethingWith:(GTMFoo*)theFoorect:(NSRect)theRectinterval:(float)theInterval{...}如果方法名比参数名短,每个参数占用一行,至少缩进4个字符,且为垂直对齐(而非使用冒号对齐)。如:-(void)short:(GTMFoo*)theFoolongKeyword:(NSRect)theRectevenLongerKeyword:(float)theInterval{...}(5)方法的调用调用方法沿用声明方法的习惯。例外:如果给定源文件已经遵从某种习惯,继续遵从那种习惯。所有参数应在同一行中,或者每个参数占用一行且使用冒号对齐。如:[myObjectdoFooWith:arg1name:arg2error:arg3];或[myObjectdoFooWith:arg1name:arg2error:arg3];和方法的声明一样,如果无法使用冒号对齐时,每个参数一行、缩进4个字符、垂直对其(而非使用冒号对齐)。如:[myObjshort:arg1longKeyword:arg2evenLongerKeyword:arg3];(6)***@public和***@******@public和***@private使用单独一行,且缩进1个字符.(7)Protocals类型标示符、代理名称、尖括号间不留空格。该规则同样适用于:类声明、实例变量和方法声明。如:***@interfaceMyProtocoledClass:NSObject<NSWindowDelegate>{***@privateid<MyFancyDelegate>_delegate;}-(void)setDelegate:(id<MyFancyDelegate>)aDelegate;***@(及其categoryname和protocalname)以“UM”为前缀,首字母大写进行分割的字符串。,且使用首字母大写的形式分割单词。方法的参数使用相同的规则。方法名+参数应尽量读起来像一句话。getter的方法名和变量名应相同。不允许使用“get”前缀。如:-  (id)getDelegate;//禁止-  (id)delegate;//对头本规则仅针对Objective-C代码,C++代码使用C++的习惯。,且首字母小写,且使用首字母大写的形式分割单词成员变量使用“_”作为前缀(如:“NSString*_varName;”。虽然这与苹果的标准(使用“_”作为后缀)相冲突,但基于以下原因,仍使用“_”作为前缀。使用“_”作为前缀,更容易在有代码自动补全功能的IDE中区分“属性()”和“成员变量(_userInfo)”