编码规范之感想

来源:互联网 发布:1元域名 编辑:程序博客网 时间:2024/04/30 13:57

     说说编码规范吧,以前感觉不到编码规范的重要性,总抱着 “老子天下第一”的心态在那编码,想在哪加个方法就加个方法,变量命名想到什么就是什么,有时候连个简单的注释都找不到。虽然有时候自己写的代码隔个几天自己看起来也有点困难,但是编码的逻辑还是符合个人的思路,多看几遍也就看懂了。我曾经有个同事,因公出差了一个礼拜,回来之后看不懂自己的代码了,看了2天才熟悉了自己的代码!

     当时那个项目,项目组成员各自为阵,为了实现某一个功能,个人也是各施其法,有时候显然是一个功能,每个人都在自己的模块里实现,并且实现的方法也因人而异。当时那个项目虽说有两个SE(当时偶是个小兵),但是从来没有做过review代码的活,可能是项目经理没有要求吧。(不好意思在这说了些风凉话,SE和项目经理人还是挺好的,可能是欠缺管理经验吧)

     现在在做的这个项目(现在还是个小兵),虽说有过代码review,大家还是基本按着规约来coding,但是由于两个SE对编码规约的理解及重视度,导致出来的source是两种风格,准确地说,是大于两种风格,每个人在编码中还是会加入自己的理解。即使有两种风格,代码维护起来也有一定难度,如果不了解业务,要想看懂代码,太难。实际上,编码工作到了后期,已经没有规约的约束,大家都忙着实现功能,完全将那些束缚编码人员行为的规范抛之脑后。这也是导致项目到了后期维护困难的主要原因之一。

 昨天,我看了我维护的别人写的一段代码,就两字:无奈。为什么实现同样的业务逻辑,做法就和别人不一样呢,定义了N多局部变量,并且通过这些局部变量来控制逻辑,“可喜”的是,这些局部变量也没有注释。

 通过这个项目,看到了一些日本人写的代码,才感觉自己加的那些注释都是.....,他们的注释可以不用改动生成帮助文档,关键代码处也都标着注释。再看看自己的代码,因为很多注释都是后期补上的,再加上注释也要用不熟悉的日文来写...总之,由于各种原因,导致自己看自己的注释都纳闷,关键部分的注释没有,有可能产生错误的地方没有提示,提供的公共接口也没有详细说明...

 据我所知,国内很多项目都是在后期补注释,尤其是工期比较紧张的项目,大家谈到注释也都一笑而过,这样的现象大家或多或少的都应该见过。

 导致这些的原因是什么呢?就是因为我们没有遵守规约?

 实际上我感觉,这就是人的惰性在作祟了,还有人的反抗的情绪。“我为什么要去遵守别人给我的约定,我只要实现你让我实现的功能,你不需要管我用什么样的方法实现”,这句话有时候也会在我的脑海里浮现。

 就此搁笔,虎头蛇尾!