1173710108软件构造心得——善待你的队友就是善待自己

				                                    善待你的队友就是善待自己——面向可理解性的编程

绝大多数时候,软件都不是你一个人写,你会有队友,会有同事合作伙伴,写软件这件事本身是比较枯燥痛苦的,尤其是当你给你的同事一份没有注释,类名完全无法推知其功能的代码时。为了延续现实世界的生命,请善待自己的队友,这很大程度上是为了自己人身安全考虑。
对于代码的可理解性主要有以下几点:
  1.首先就是我们老生常谈的命名,我们在代码中离不开命名。然而,在编程的过程之中,我们很有可能忽视命名的重要性,因为我们很多时候认为算法,结构才是我们关注的重点。但是。。。。你经历过看不懂自己代码的恐惧吗(尤其是对于初学者),不规范的javadoc以及不明所以的变量命名都会让人头大,因此下面会针对这一个方面给出一点建议。

(1).trade-off是必须的。
  (2).尽量避免同名变量的使用,虽然很方便。之前写C程序的时候,一个练习程序撑死能有个300行,这个时候我就很喜欢用A,B,C,D
  这种简单的变量名,现在回过头来一看简直是想打死当时的自己,如果是我的同事,搞了一坨ABCDEFGHIJKMN给我,我一定会拿出我的40m大刀砍他的。
  2.其次便是文档以及文件夹的组织问题,如果将自己创建的类随意地进行防治,A包中放置原本属于B包中的内容,B包中放置原本属于C包中的内容,这就会直接导自己在看文件结构时一脸懵逼,特别是当报错时,e.printstackTrace重重叠叠的跳转,会让人真的爆炸,因此,下面给出一点建议
  (1).注意构思规划

对号入座,每一个java的类,每一个包都应该负责一个特定的功能模块,只有把每一个类的功能想好,才能保证在创建类的时候能够较好地保证层次以及逻辑清晰。这里就千万不要怕,不要怕一个类定义了没干什么大事,一个类能做的事越单一越好,之前写代码会犯一个类解决多个问题的错误,写着写着就不是JAVA了,变成了C语言里的main函数而还是极度冗长版。

(2).注意包名以及类名

这又是涉及到命名了,如果较好地完成了命名,那么看层次时就会有一目了然的快感(是的,就是快感!!!),无论是进行测试还是代码走查,都会很轻松地完成。

引用别人的一句话:为什么几十万字的小说看一遍我们就可以理解, 而几千行code却要一读再读?

  • 0
    点赞
  • 0
    评论
  • 0
    收藏
  • 打赏
    打赏
  • 扫一扫,分享海报

参与评论 您还未登录,请先 登录 后发表或查看评论
©️2022 CSDN 皮肤主题:大白 设计师:CSDN官方博客 返回首页

打赏作者

weixin_40565004

你的鼓励将是我创作的最大动力

¥2 ¥4 ¥6 ¥10 ¥20
输入1-500的整数
余额支付 (余额:-- )
扫码支付
扫码支付:¥2
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值