代码规范这个问题已经是老生常谈了，但是还是会经常碰到让人看到炸裂的这种项目。最近手里有一个iOS老项目需要迭代升级，1.0版本应该是印度那边的团队写的，后来不知道又经过多少人的手迭代最终到了我手里，我打开项目看的时候，就为了找一个方法找了半天。作为一个工业工程专业出来的选手，我怎么可能会容忍这样让人崩溃的代码（还好项目不是特别大），这个项目再不整理真的没办法再搞下去了，所以我要改造它！那么如何入手成为了一个问题，不过毕竟是受到了四年的IE知识的熏陶，我觉得5S现场管理法，很适合作为代码规范改造工作的理论指导。
一、 什么是5S管理?
5S现场管理法，现代企业管理模式，5S即整理（SEIRI）、整顿（SEITON）、清扫（SEISO）、清洁（SEIKETSU）、素养（SHITSUKE），又被称为“五常法则”。
5S管理其实是一种现代企业管理模式，通过实行5S管理活动，整理工作环境，建立标准化，规范行为，增强每个人的责任感和纪律性，使人人都能自主管理，从而达到提高产品质量，降低生产成本的目的。5S中前面4个S是手段最后一个S是目的，让每个人都养成认真规范的工作习惯。
整理：区分要与不要的物品，现场只保留必需的物品；
整顿：必需品依规定定位、定方法摆放整齐有序，明确标示；
清扫：清除现场内的脏污、清除作业区域的物料垃圾；
清洁：将整理、整顿、清扫实施的做法制度化、规范化，维持其成果；
素养：人人按章操作、依规行事，养成良好的习惯，提升个人素质。
二、为什么要代码规范？
这个问题其实大家都明白的，但是看到这些让人炸裂的代码，还是再列一下吧：
1、规范的代码可以促进团队合作，减少沟通成本；
2、规范的代码可以一定程度上的减少Bug；
3、规范的代码可以降低维护成本；
4、规范的代码有利于代码调试以及Code review；
5、最重要的一点，养成代码规范的习惯有助于我们自身的成长。
三、如何使用5S去管理你的代码？
在5S管理中是针对人机料法等生产要素进行管理，对于我们来说，我们的目标管理对象就变成了我们的Code，我们按照5S管理的步骤来开始我们的代码管理工作。
1.整理你的项目：首先把垃圾清理出去。经过多次迭代开发，功能模块多次增减改变，很多东西比如说一些资源文件或者类文件已经废弃没有在使用了，整个项目变得用臃肿不堪。所以我们把这些用不到的或者说已经废弃的东西区分出来统统删掉，只保留那些有用的东西，剔除垃圾给项目瘦身。其实这也是在减少出错的机会，一定程度上提高代码的使用安全性。
2.开始整顿：通过前一步对项目进行整理完成后，需要对留下的那些进行科学合理的布置和摆放。按照项目架构将对应的类文件、资源文件合理放置，使你的工程目录结构清晰可辨，这样可以减少寻找目标代码的时间，用最快的速度取得所需之物，消除因混放而造成的差错，同时还能提高Code review效率。还有最重要的一点，这样可以使你的项目看起来很清爽的感觉，降低你情绪爆炸的几率。
3.对代码进行清洁：此时我们就要开始对代码进行处理了，这个不带注释的btn1，btn2，是个什么鬼？写Demo的时候也不至于这么随意吧。我们首先按照通用的代码规范对代码进行整理，代码逻辑清晰、美观、缩进整齐有序。一个优秀的程序员最重要的不仅仅是写出让机器能看懂的代码，更重要的是写出让人类可以看明白的代码。一定要记得随时随地写注释，不要觉得麻烦，反而恰恰是在为以后的工作提供方便，注释并不是为别人而写的，最重要的服务对象是我们自己啊，Debug的时候，维护的时候，一个完美的注释，不知道可以节省多少时间，提高多少效率。不要让自己写的代码给搞晕了，所以不管是为别人还是为了自己写好注释都是很重要的。我们要在最有效的最简洁的流程下完成工作，代码规范清楚，注释清晰明了，既美观又高效啊，大兄弟们！
4.将以上成果制度化：以上三个步骤完成之后，项目结构清晰可辨，代码整洁规范，让人一目了然。可是此时工作并没有结束，这次改造的这个项目已经好几年了，然而一直在裸奔，并没有形成对应的说明文档和其他技术文档。我们应该将这些工作的成果总结记录，最终形成一个书面文档，这样不管是将来我们自己维护，或者是让其他开发人员来维护的时候，都有章可循。很容易就可以掌握项目的整体结构，可以迅速寻找到目标代码进行Bug修复或者是添加对应功能模块，极大的提高了维护效率，降低维护成本。
5.提高个人素养：做完了以上工作，我更加的认识到编写规范代码的重要性了，我在以后的开发工作中，更是要坚持下去。虽然拥有良好的开发习惯并不意味着开发水平有多高，但是却是成为一个高水平程序员的必要条件。我们平时查看那些优秀的开源项目的时候就可以发现那些代码都是及其及规范的，我们可以很容易的理清楚其逻辑架构。不管是团队开发还是个人开发，如果已经制定了相应的规范准则，那么我们就坚持去实施，如果没有的话，我们完全可以自己按照通用代码规范来约束自己。其实说到底再怎么先进的管理方式，再良好的制度，离开了执行一切都是空谈。最重要的是我们能够认识到规范的重要性，从自身来坚持规范开发，养成良好的开发习惯，归根结底还是要解决人的因素。
好了就此顺利完成了本次改造工作，看着这清爽的目录结构，整洁规范的代码真的是莫名的开心，感觉敲代码都有劲了，很快就添加了对应的功能，完成了升级迭代工作。其实有的时候我觉得在IE的许多手法都是可以运用在我们的开发或者是维护工作的，并且可以很好的提升我们的开发效率，保证项目质量。
PS：写一些自己的一点小想法，不妥的地方大家多批评！
网友评论