美文网首页
代码规范

代码规范

作者: 西北望高楼 | 来源:发表于2016-09-14 10:36 被阅读38次

1. 命名规则:

a) 类名首字母大写,方法首字母小写,方法中的参数首字母小写。所有命名采用驼峰命名法。
b) 所有命名不允许与系统参数命名一致,例如:

UITableView *tableView。

c) 宏定义命名大写字母,能直观表达出宏定义的含义,单词之间以下划线隔开,例如:

#define DISPATCH_SOURCE_TYPE_TIMER。

d) 命名禁止使用单字母,应该尽量能表达变量含义,而且要有注释解释说明。
e) 私有变量的声明命名。
f) 全局变量的声明命名。
g) 方法的声明命名。
h) 资源命名规则:见第5条。

2. 注释

a) 所有的需要注释的地方:类文件的解释,变量或参数的解释,方法的解释,宏定义的解释,代码逻辑的解释等。
b) #pragma mark - 或者 // MARK: 标记分类。
c) 所有注释尽量采用代码块注释:/** 这样的注释 */。
d) 解释类注释必须采用代码块注释。例如:方法名解释,版权解释,类解释,变量或参数解释等。
e) 对OC:私有变量或方法的声明一律写进实现文件.m中。
f) 推荐使用插件:VVDocumenter-Xcode

3. 对齐、换行与缩进

a) {}:{ 跟在外部代码后面的,内部代码与上 { 之间保持一个换行。{ 与外部代码另起一行的,内部代码不必另起一行。{}
b) 代码块与代码块之间,必须保持换行(空一行或两行),不允许出现从上到下一堆。
c) @关键字与代码保持空一行。
d) 所有代码必须保持对齐。

4. 空格

a) 运算符前后必须加空格。
b) 多参数,每个参数的逗号后必须加空格,例如:time(x, y)。
c) 星号 * 与类型必须有一个空格,与变量之间无空格,例如:NSString *str。

5. 资源命名规则

资源命名全部使用小写字母,单词之间以下划线分隔,应能充分表达意思,以前缀区分资源,防止重名,以后缀区分资源类型(比如图片正常状态,高亮状态等)。

6. 编码

保证每一行代码都要简洁、明了,对比如下:
不提倡的非规范代码:
    unitYuXi.navigationItem.title = [[[skListArray objectAtIndex:indexPath.section] objectForKey:@"units"] objectForKey:@"title"];
提倡的规范代码:
    NSDictionary *msgDict = [skListArray objectAtIndex:indexPath.section];
    NSDictionary *unitsDict = [msgDict objectForKey:@"units"];
    unitYuXi.navigationItem.title = [unitsDict objectForKey:@"title"];
模块化开发

代码尽可能功能模块化,所有代码文件保证1000行代码之内。
封装:把模块化的功能全部封装出来,封装时要注意,只处理功能效果,不负责业务逻辑处理。

<待完善>#####

相关文章

  • Web 端代码规范

    目录 1、代码规范概述 2、代码规范流程搭建 3、代码规范细则 1、代码规范概述 良好的代码规范能够提供软件的可读...

  • 代码规范

    代码规范 1. 概述 欢迎使用前端代码规范, 这里借鉴、引用的是京东前端代码规范。 遵循代码规范的目的在于增强团队...

  • iOS 代码规范篇

    iOS 代码规范篇 iOS 代码规范篇

  • iOS(OC)开发之随感

    1.代码规范 规范很重要!规范很重要!规范很重要! 代码规范的重要性之-为什么谷歌要执行严格的代码编写规范http...

  • 前端学习的基本总结

    目录 1.为什要遵守代码规范 2.css代码规范 3.js代码规范与设计模式3.1 js代码规范3.2 设计模式 ...

  • 乐乎项目优化

    编程: 1、代码规范。架构规范、文件组织规范、命名规范、代码逻辑规范、资源存放。 一、使用cocoapod 二、代...

  • 小肤iOS开发代码规范_v1.0

    For Objective-C , 2018.8.2 Ⅰ.前言Ⅱ.命名规范Ⅲ.代码注释规范Ⅳ.代码格式化规范Ⅴ....

  • 代码规范

    代码规范 1. 概述 欢迎使用代码规范, 这个是我借鉴京东前端代码规范,组织的内部规范。旨在增强团队开发协作、提高...

  • PSR-2- Coding Style Guide 编码风格规范

    代码风格规范 本篇规范是 PSR-1 基本代码规范的继承与扩展。 本规范希望通过制定一系列规范化PHP代码的规则,...

  • PM篇

    PM 技术篇1.开发规范命名规范,异常处理规范,日志规范,统一框架,代码commit规范,代码评审规范,统一API...

网友评论

      本文标题:代码规范

      本文链接:https://www.haomeiwen.com/subject/mhjvettx.html