代码规范

命名和使用
类名首字母大写
变量、属性和方法名首字母小写驼峰
常量大写
命名使用英文含义单词或缩写
代码中使用了硬编码
API命名不清晰
代码风格
单行长度小于等于120个字符
缩进使用2个空格、4个空格或1个tab
代码行中保留适当的空格,不同功能代码之前保留适当的空行
代码循环或回调嵌套层次避免超过4层
类不要超过1000行,方法不要超过200行
函数参数小于等于4个,多于4个参数使用对象传递
未使用的代码,直接删除掉,避免多行代码的注释
对外提供的共有方法/属性、复杂逻辑部分,需要增加必要的注释
设计与开发
逻辑不清晰,或者冗余的
逻辑代码重复,相同功能代码应抽象为函数或类
入参合法性校验
功能API拆分清晰,简单易维护
提交代码时commit msg需要清晰明确
iOS API 不要以get/set开头,Android可以
只暴露必须的共有方法给外部使用,iOS在头文件中声明,Android用public关键字
成员变量Android以get/set方法提供,iOS以只读属性/方法在头文件中提供;
业务模块尽可能减少耦合, 耦合部分通过接口实现
API返回值设计不合理,例如db的update操作,都需要有返回值,同类型的不合理问题不重复计分
有逻辑bug,或者缺少临界值校验,可能导致异常crash的问题
日志与埋点
关键点需要使用UBT监控埋点
合理使用UserDefault/SharedPreference、Database、File等存储日志/数据
适当的使用日志API,生产环境应尽可能避免log直接输出到控制台
多线程
所有UI操作,必须在主线程
可变全局变量/成员变量的修改,必须要考虑到多线程同步
耗时操作必须放到非主线程操作
技术选型
尽可能使用公司标准,避免重复造轮子
如果该组件或方案公司已经提供,请采用公司方案
如果公司方案不能满足自己的需求,正确的做法是
提需求改进
提需求后仍然未改进,则升级处理
直接要求参与开发
如果公司没有现成方案,但是有开源方案,应该采用开源方案
其他 ( -5 ~ +5 )

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,185评论 6 503
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,652评论 3 393
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,524评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,339评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,387评论 6 391
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,287评论 1 301
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,130评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,985评论 0 275
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,420评论 1 313
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,617评论 3 334
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,779评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,477评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,088评论 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,716评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,857评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,876评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,700评论 2 354

推荐阅读更多精彩内容

  • iOS编程规范0规范 0.1前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、可靠、可 测试、高效...
    iOS行者阅读 4,456评论 21 35
  • 推荐文章:禅与 Objective-C 编程艺 前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、...
    WolfTin阅读 2,757评论 0 1
  • 示例 下面是一个示例头文件,演示了@interface声明的正确注释和间隔 一个示例源文件,演示了一个接口的@ i...
    我是Damo阅读 1,993评论 2 5
  • display 属性 开启弹性布局 伸缩容器的各属性 1. flex-direction 属性 指定主轴的方向 ...
    学不会灬阅读 448评论 0 0
  • 我们听到这个词语是五年以前,翟召博老师来博山培训我们,作为家庭教育的初学者,什么“延迟满足”,什么“无条件接纳”...
    丹林映日阅读 251评论 0 0