博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
iOS团队编码规范
阅读量:5044 次
发布时间:2019-06-12

本文共 699 字,大约阅读时间需要 2 分钟。

不规范的代码,读起来身心俱惫,改起来后患无穷。

命名原则:

1.最少字符,尽量的减少命名对象的长度,选择字符少的名词

2.名符其实,命名应该能直观的描述被命名对象是什么或者做什么

3.避免歧义,尽量不要采用多义词,也不要使用命名组合之后产生多义的方式

4.上下文一致,比如谓词的统一性,如果都是集合类,那么使用Remove表示删除操作,那么所有上下文就应该都用这个Remove,而不要再用Delete

5.少用缩写,除非是很常见的缩写或者项目中定义好的缩写,否则不要使用缩写

6.优先使用全局常量而非宏,应使用static方式声明常量;

一、目录命名

以功能模块划分目录,使用大驼峰法命名,例:Discovery,并关联实体文件夹。

二、类命名

遵循命名原则,使用大驼峰法命名,通常在类的头部.h文件添加类注释,标明该类的用途。

三、属性命名

1. 一般变量名使用小驼峰命名规则,不要使用下划线。

2. 类属性变量用小驼峰法。

3. 类的成员变量用小驼峰命名法并加上下划线开头的方式命名。

四、方法命名

使用小驼峰法命名,方法名使用动词短语,能具体表达出该方法的功能,参照系统方法:

更多编码规范请参考:https://github.com/raywenderlich/objective-c-style-guide

注释规范

链接到另一篇文章:

文章介绍各类注释方法、应用场景,并搭配快捷键实现快速注释。

以上属于臭码农原创,若有雷同属巧合,如有错误望指正,转载请标明来源和作者。by:臭码农

转载于:https://juejin.im/post/5a323eaf6fb9a045211ebaff

你可能感兴趣的文章
webStrom智能提示忽略首字母大小写问题
查看>>
层叠加的五条叠加法则(一)
查看>>
设计模式六大原则(5):迪米特法则
查看>>
对Feature的操作插入添加删除
查看>>
javascript String
查看>>
ecshop 系统信息在哪个页面
查看>>
【转】码云source tree 提交超过100m 为什么大文件推不上去
查看>>
Oracle数据库的增、删、改、查
查看>>
MySql执行分析
查看>>
git使用中的问题
查看>>
yaml文件 .yml
查看>>
linux字符集修改
查看>>
phpcms 添加自定义表单 留言
查看>>
mysql 优化
查看>>
读书笔记 ~ Nmap渗透测试指南
查看>>
WCF 配置文件
查看>>
动态调用WCF服务
查看>>
oracle导出/导入 expdp/impdp
查看>>
类指针
查看>>
css修改滚动条样式
查看>>