浅析我对代码规范的理解

代码整齐，有必要的换行缩进，看起来舒服；

函数功能分类，每个功能用#pragram mark - 或//MARK：区分开，并附有说明；

函数命名可读性强，让别人根据函数名即可知道函数的功能。如果函数的功能比较复杂，应有关键步骤的注释，有函数参数，返回值和函数功能的注释说明；建议使用VVDocumenter写函数注释。

函数中的变量要有意义。不要出现int a，var b这样的字样。尽量采用text，number，date，width等有意义的文字。如果零时使用，可以采用tmp，local等前缀字样，让别人快速的明白是零时使用。

一个类单独形成一个文件。如果一个文件中包含多个类，那么这些类之间必须要有相互关系或一个体系，比如纯虚基类和实现子类，一个类和仅仅为该类服务的help类。

类的功能由自己内部实现，而不是通过外部设置，万不得已不对外暴露变量，对外只提供更新的接口。外部只需要提供简单的设置和数据就能够让类完成自己的大部分功能。

资源文件按业务功能模块分开。比如Images.xcassets拆分出多个，每个模块有自己独立的Images.xcassets文件，类似ModuelA.xcassets，ModuelB.xcassets等等，通用的icon文件放在Images.xcassets中。

看代码时，不用文档，或很少文档，就能让其他人上手。模块目录按照功能进行分类，比如联系人页面所有涉及到的Controller，View、Model和资源文件一起放在Contacts文件夹里。我见过有的代码是将所有Controllers放在一个文件夹中，Views放在一个文件夹中，Models放在一个文件夹中，这样的文件目录读起来感觉非常不方便。

粒度够细，集成度高，复用度高。功能函数化，参数变量化。能够达到改动一个地方，所有地方生效的结果。

尽量使用自定义View，View封装的粒度要细，自己能够完成大部分功能，对外仅暴露初始化接口和回调，便于移植和修改。

image使用时，icon使用imageNamed函数初始化，图片文件采用imageWithContentsOfFile函数初始化，用以防止不必要的缓存。

网络请求采用统一的接口设置，便于将来接口的修改。

转载于:https://www.cnblogs.com/gongyuhonglou/p/10311606.html

浅析我对代码规范的理解相关推荐

eslint 保存自动格式化_代码规范之理解ESLint、Prettier、EditorConfig
授权转载自:nowThen https://juejin.cn/post/6895889063111294990 前言团队多人协同开发项目中困恼团队管理一个很大的问题是:无可避免地会出现每个开发者编 ...
浅析C++代码规范注释有哪些讲究？
作为一名合格的C++开发工程师,不仅需要了解清楚开发技术之外,还需要了解清楚C++注释的用法,这是因为注释虽然写起来很痛苦,但对保证代码可读性至关重要. 浅析C++代码规范注释有哪些讲究? 下面的将描 ...
代码的c++实现_一文带你快速理解FreeRTOS代码规范~
[导读] 遇到些朋友感觉FreeRTOS内核代码看起来很不习惯,不习惯其编码风格,本文就来梳理一下其代码规范,便于提高阅读其代码的效率.代码基于FreeRTOS V10.4.3. FreeRTOS代码 ...
代码规范+设计模式落地之路
欢迎关注方志朋的博客,回复"666"获面试宝典 | 前言刚刚与同事开了一个分享会,笔者分享了一些了代码设计模式相关的内容. 以及复盘了一下项目中有些复杂的业务场景,为什么没有很好 ...
代码规范之华为公司代码规范
华为公司代码规范转于http://blog.sina.com.cn/s/blog_61176a740100ffer.html 内容简要:写代码习惯以及注释的要求. 1-1:程序块要采用缩进风格编写, ...
嵌入式C语言代码规范
C语言代码规范参考安富莱C语言编码规范 1.文件与目录 1.文件及目录的命名规定可用的字符集是[A-Z:a-z:0-9:._-]. 2.源文件名后缀用小写字母 .c 和.h. 3.文件的命名要准确清 ...
百度代码规范 -- PHP
来源:http://blog.csdn.net/sinat_34990639/article/details/62423641 php编码规范 php标准委员会(php-styleguide@baid ...
C语言代码规范（编程规范）
首页 > 编程笔记 > C语言笔记阅读:7,165 C语言代码规范(编程规范) C语言中文网推出辅导班啦,包括「C语言辅导班.C++辅导班.算法/数据结构辅导班」,全部都是一对一教学:一 ...
【代码规范】google开源c\c++项目代码规范
版权声明:版权声明:本文为博主原创文章,未经博主允许不得转载;https://blog.csdn.net/csdn_baotai https://blog.csdn.net/csdn_baotai/a ...
[译] ROS C++ 代码规范
内容说明 : 文章内容翻译自ROS Wiki,也引用了部分<代码整洁之道>书中的内容. ROS C++代码规范与谷歌C++代码规范有诸多相似之处,本文主要讲述在编写ROS C++代码时需要 ...

浅析我对代码规范的理解

浅析我对代码规范的理解相关推荐

最新文章

热门文章