xcode插件7.1规范注释生成器

xcode 插件 7.1 规范注释生成器篇一：IOS 编码及注释规范IOS 开发编码及命名规范 目录 1、目的 .3 2、适用范围.3 3、编码规范.3 、文件. 3 、注释. 3 、编码排版格式 .5 、命名规范 .6 、保留字 . 6 、方法.7 、变量.7 、常量.8 、类.9 图片命名 .9 、修改规范 .9 、新增代码行 . 9 、删除代码行 .10 、修改代码行 .10 、其他规范 . 10 1、目的 统一规范 XCode 编辑环境下 Objective-C 的编码风格和标准 2、适用范围 适用于所有用 Objective-C 语言开发的项目。 3、编码规范 、文件 1) 项目文件必须使用一个有意义的名字一般用bundleId 最后一位如 lender .xcodeproj。 2) 公共文件统一命名为 。任何文件的命名尽量不要以中文命名。 3) 对于文件的目录要按如下结构创建： -Document（文档所在路径） -Help（帮助文件所在路径） -图片等资源文件放在单独的目录与组(Group)中，如Images。 -所有的 view 放在单独的组(Group)中，如 Custom View。 -所有的 viewController 放在单独的组中，如viewControllers。 -引用外部文件或者某个单独的功能时，放在单独的组中， 例如： 程序中使用了 coverflow 功能，引用 openflow 的文件时，将其全部文件放在 openFlow 这个组中。其 view 和viewcontroller 等文件的组织不受上面所规定的影响。 4) bundleId 命名：公司的域名反过来最后一位是项目名称一般越短越好 举例：*() 、注释 1) 注释可以采用 /* */ 和 / 两种注释符号，涉及到多行注释时，尽量使用 /* */ 。 2) 对于一行代码的注释可放在前一行及本行上，不允许放在下一行，更不允许在一行语句的中间加入注释。 3) 单元文件的文件头注释说明应按如下格式： / 文件名 / 工程名 / / Created by 创建者 on 日期. / Copyright XX xxx 有限公司. All rights reserved. / / 系统名称： / 功能描述： / 修改记录：(仅记录功能修改) / 张三 XX-02-02 创建该单元 / 小明 XX-03-02 增加本地点单功能。 / 4) 方法前面的注释遵循以下格式：如果某项没有，则以 N/A 表示 例如： /* 函数名称：-(BOOL)showFiveAndSixStairRoomCountByStatu 函数描述：显示特定状态下五楼和六楼的房间数 输入参数：(NSString *)statu：某状态。 输出参数：(int *)roomCount ：该状态房间数量。 返回值：BOOL：操作是否成功。 */ - (void)showFiveAndSixStairRoomCountByStatu:(NSString *)statu roomCount:(int *)_roomCount; 或 /* 函数名称：-(NSUInteger)showFiveAndSixStairRoomCount 函数描述：显示五楼六楼的房间数。 输入参数：N/A 输出参数：N/A 返回值：NSUInteger :房间数量。 */ - (NSUInteger)showFiveAndSixStairRoomCount 5) 不必每行都加注释，在 310 行左右的段落做注释要好于每行都做注释，显而易见的代码不加注释。 例如： if (!returnValue)/调用登录过程失败 ?无用的注释 NSLog(”登录失败”); 、编码排版格式1) 代码的缩进应使用空格（SPACE） ，不能使用制表符（TAB） ，并且缩进以 2 个字 符为单位。 2) 中括弧的每一个括弧在源程序中要单独占一行。 例如 /不正确用法 for (int i = 0; i ? /正确用法 for (int i = 0; i ? 3) 空格的使用 a) 关键字与其后的表达式之间要有空格，如： if (expr) 或 for (expr) b) 单目操作符不应与它们的操作数分开（如!和等） 。 c) 除 , 外，其它双目操作符应与它们的操作数用空格隔开。 例如 i=i+1; /错误的写法，操作符两端没有空格 i = i + 1;/正确的写法， if(ab) /错误的写法，逻辑判断符号两端没有空格if(a b)/正确的写法 d) .h 中协议前面有一个空格。 e) .h 中成员声明时，类型与变量之间有至少 1 个空格。*号靠近变量，不靠近类型。f) property 后留 1 个空格， （）里面，逗号紧跟前一变量，与后一变量之间留 1 个空格。 （）外面，先留 1 个空格，再声明属性。 g) 方法的+，-后面与（）之间留 1 个空格。 h) 返回类型与*之间留 1 个空格，方法参数中返回类型与*之间留 1 个空格。i) 在多参数方法中，每个参数后面都有 1 个空格。 4) 每行只能有一个语句 例如 /不正确写法 NSUInteger objectIndex, stuffCount; 或 objectIndex = objectIndex + 10, stuffCount = stuffCount + 20; 或 synthesize MyView, MyLabelView; /正确写法 篇二：10 个提升 iOS 开发效率的 Xcode 插件10 个提升 iOS 开发效率的 Xcode 插件 时间就是金钱。编码效率的提升意味着更多的收入。可是当我们的开发技巧已经到达一定高度时，如何让开发效率更上一层楼呢？答案就是使用开发工具！在这篇文章中，我会向你介绍一些帮助我提升编码速度和工作效率的工具。 Xcode 插件 几乎所有开发者都知道 Alcatraz 是一个开源的包管理工具，可以让我们更轻松地管理各种插件。接下来就介绍下我的最推荐的 10 个插件： 在编辑字符串的时候，它会在代码上方生成一个字数统计的提示框。当你需要编辑多行文本时，可以在弹出的文本框中编辑字符串内容，插件会自动进行字符转义的工作，并实时在代码中更新。 一个简洁的可视化颜色插件。在你编辑颜色的 RGB值的时候，会在代码上方出现一个小的色块，显示对应的颜色。点击色块还会弹出一个颜色编辑器，在编辑器中得到的色值会自动填入 colorWithRed:green:blue:alpha:方法中，贴心！ Data Exterminator 当你在编译项目的时候，是否曾为 Xcode 爆出的某个奇怪的错误绞尽脑汁？我想答案是肯定的，并且我们都明白，其中的一种错误的解决办法就是删除 DerivedData!尽管我们有很多种方法解决这个问题，但 Derived Data Exterminator 无疑是最便捷的那种。在我们将它集成到Xcode 后，就可以一键清理 Derived Data。 你是否已经厌倦了反复写 NSLocalizedString？如果是，那么 QuickLocalization 插件可以助你一臂之力。当你在编辑字符串的时候，只需要按下 option+shift+d，就可以将“Any String”转换成 NSLocalizedString(“Any String“, nil)。而且还可以通过修改配置来定义要出现在 comment字段中的内容。过去，我不得不频繁查看资源文件夹以查找合适的图片的名称。使用 KSImageNamed 插 件后，会自动弹出图片名称的列表以供选择，而且还有缩略图，十分便捷。代码审查是 Netguru 大神们生活方式的一部分。尽管大部分 bug 会在此阶段被检查出来，但我们仍然会在使用他人代码的时候发现问题。这个时候，ShowInGithub 大显身手的时候到了，只需要按下 ctrl+C 或 ctrl+G，就可以立即打开 commit 或 file 页面，同时支持 Github 和BitBucket，非常棒！ Switch 语句相当繁琐。虽然它清楚地列出了在每种情况下应该处理的方式，但一个个填入枚举值那真是浪费时间。SCXcodeSwitchExpander 插件可以帮我们完成这个工作，它可以自动获得所有的枚举值填入相应的位置，而我们只需在每个枚举值下面填入对应的逻辑即可，方便极了！尽管给所有的文件都做上注释的感觉很棒，但是你是否想过这得花多少时间？事实上，感谢 VVDocumenter-Xcode，真不需要多少时间。它可以自动解析方法的参数及返回值，并形成 Javadoc 风格的注释。我们写的所有开源代码都使用了这个插件。 这个插件可以在编码的时候自动补全代码。它的强大之处在于，使用了与”Open Quickly”功能相同的算法，如，当你想使用“tableView:cellForRowAtIndexPath:”方法，原来需要输入冗长的“- (void)tableView:(UITableView *)tableViewce”才能匹配出方法，而现在只需要” - cellFor”就行，省事多了。这是我最喜欢的插件，我完全想象不了如果编码的时候没有它怎么办。通过配置，我们可以使用光标或者不精确的选择就可以剪切或者拷贝代码行，可以在粘贴代码的时候不触发代码格式化，还可以通过在.m 文件中拷贝方法，粘贴进.h 文件的时候就可以得到自动格式成的方法声明，还有好些功能都可以实现。XcodeBoost，值得你拥有！本文来源：果合移动广告转自 CocoaChina 篇三：Object-C 编码规范Object-C 编码规范当前版本 文档编号 总页数密级机密正文页数附录页数 0 ?北京陆优科技有限公司 java 编码规范编制人王春 评审人批准人编制日期 02 评审日期批准日期修改履历评审 序 号 状 态 版 修改内容 本 位置 日期 日期 创建 Object-C 编码规范文档初 1 C 稿。 王春 修改 修改人 人批准 人 日期 2345 6 第 1 页，共 15 页?北京陆优科技有限公司 java 编码规范7891011121314 状态：C创建文档，A增加内容，M修改内容，D删除内容目录 1 引言 . 4 2 目的 . 4 适用范围 . 4 定义、首字母缩写词和缩略语.4 编码规范 . 4 文件 . 4 注释 . 5 编码排版格式 . 7 命名规范 . 9 第 2 页，共 15 页?北京陆优科技有限公司 java 编码规范修改规范 . 新增代码行 . 13 删除代码行 . 13 修改代码行 . 13 第 3 页，共 15 页?北京陆优科技有限公司 java 编码规范 1 引言 目的统一规范 XCode 编辑环境下 Objective-C 的编码风格，提高程序的可读性、可测试性和 可维护性，同时