代码整洁(学习笔记)

软件开发中的 5S 原则:

  • 整理:命名的规范
  • 整顿:把你的代码放在它应该在的地方
  • 清楚:整洁代码
  • 清洁:代码风格、实践手段
  • 身美:不断改进

有意义的命名

  • 变量名、方法名:使用小驼峰法 --- 除第一个单词之外,其他单词首字母大写
eg:
var myStudents;
function getStudentById(){}
  • 类名:使用大驼峰法 --- 所有单词的首字母都大写
eg:
class BaseUser{}

好的命名遵循下列的规范:

  • 名副其实:不需要被注释也应该被理解、看懂。怎么用、做什么事、为什么存在
  • 避免误导:(I 、O),这到底是 I 还是 1,是 O 还是 0;(傻傻分不清)
  • 做有意义的区分:
    不要使用 a1、a2、a3
    不要说废话(student 就不要再写成 studentInfo 或者 studentData 了)
  • 使用读得出来的名称
  • 使用可搜索的名称:不要使用硬编码,尽量使用常量替代
  • 一致的命名规则:比如查找都用 find**
  • 不要使用双关语

明了的函数

  • 短小
  • 每一个函数/方法应该只干一件
  • 函数参数:
    一元参数:有输入应该也有输出
    二元参数:尽量不要使用,除非参数是有序组成的(new Point(x,y))
    如果参数个数超过两个,考虑下把参数封装一下在传过去
  • 别重复自己

注释

法律信息
提供信息的注释(时间格式...)
对意图的解释
警告
TODO
公共 API

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • iOS编程规范0规范 0.1前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、可靠、可 测试、高效...
    iOS行者阅读 9,925评论 21 35
  • 推荐文章:禅与 Objective-C 编程艺 前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、...
    WolfTin阅读 7,838评论 0 1
  • 该喝的酒多喝两杯酒精教会你语言和行动说话开始飘离地心在空中变换着色彩 遗忘一颗巨大的石头让它缓缓沉入大海来来往往的...
    无法登陆阅读 1,391评论 0 2
  • 住在海边最大的好处就是一年四季可以吃到应季的海鲜,而四季中海鲜最为丰盛的季节恰恰就是在深秋时节,鱼儿虾蟹正肥。 身...
    黑白无阅读 3,966评论 5 9
  • 我害怕啊 我害怕迟早被这个世俗打败 我害怕年龄越来越大,我害怕我碌碌无为 我害怕我早早走上婚姻再也不提爱...
    也有一个林夕梦阅读 1,703评论 0 1