写给自己的几点编程建议

写给自己的几点编程建议

                                                                                                                                         ——记自己在开发过程中的所思所得

 

        14年是忙碌的一年,转眼间时间已经到了6月份。伴随着自己手头项目的结项,快节奏的开发工作终于可以暂时告一段落了。在这短暂的喘息之机,回过头来整理自己之前写过的代码,也是一件惬意的事情。经历这种回炉反思的过程,感觉对自己的成长很有帮助。下面就是自己总结的几条编程建议,提醒自己时刻注意,习惯成自然。

 

       1、 不要保留无用的注释,直接删除它们。无用的注释,比如被注释掉却没有说明为何注释的代码等。如果需要保留,那就要写明注释的原因,以及保留的原因,否则以后回过头来再次阅读源码时,一段被注释起来却没有说明的代码,会带来一些不必要的思考障碍。

 

        2、 对同一样事物,保证描述的一致性、唯一性。这样做的目的,可能对程序性能的提升没有多大影响,但却是一种好的习惯,它能在不经意之间减少阅读源码时的思考开销。比如你编写了一个发动机类,而在描述这样事物时,却一会使用发动机、一会使用引擎,甚至使用更多的词汇去描述它,我认为这会带来不必要的思考开销。因为都是同一样事物,当你每遇到一种新的描述,都要去思考确认,是不是自己想的那样,这就额外耗费了一些时间,尽管它们可能很短暂。这种描述的一致性、唯一性,主要体现在变量、方法的命名,注释中的说明等。说到这一点,我不禁想到了之前阅读的一篇讲述编程习惯的文章,里面提到的是实现同一种功能,保证方法的唯一性,即选择一种自己认为最合适的方法去做,不要使用多种方法去实现相同的功能。我想,这种唯一性的保证,是有必要的。

 

         3、 在程序中的逻辑处理部分,判断部分的if—else分支都要尽量齐全,不要遗漏。自己之前经常的行为是,写完if分支的处理部分,觉得else等分支没有什么是需要处理的,就完全对它置之不理了。殊不知,没有什么需要处理,并不等同于没有什么代码要写。像是在if中打开的渲染,你需要到else中去关闭,否则即使不进入if,渲染还是在进行等情况。每当自己处理了一个if,都要仔细思考一下,在该判断的其它分支,是否还有需要的处理要做,否则一时的遗漏,日后再修改可能耗费的时间就会更多了。

 

        4、 在给代码添加注释时,要注意动词、名词的运用,注意主谓宾的关系,不要写一些不合语言语法逻辑的注释句子。否则一时冲动写下的异型,拗口的描述也可能给日后的维护带来额外的负担。

 

        5、 自己最近发现,整理源码的注释,也是一种很不错的复习源码的方式,它能够帮助自己很快的进入源码所体现的思维之中。最近,因为有自己几个月之前的项目需要升级,而通过阅读、整理项目源码中的注释,自己很快的就熟悉了代码中的套路,享受到了一个轻松、愉快的复习源码过程。当然,项目的源码都是出自自己之手,这也是一个大的前提。希望有机会能够在同事之间进行一次源码阅读的体验,看看注释能给我们带来多么显著的帮助(还有文档: ))。

 

        好了,总结暂时就是这么多。如果大家有什么好的意见或建议,欢迎与我进行交流。要把程序写好,写漂亮,自己的路还很长呢。



        本文出自杜晓萌的博客,未经特殊表明皆为本人原创,请勿用于任何商业用途,转载请保持完整性并标明出处:http://blog.csdn.net/haohan_meng


  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值