为可读性编程

本文探讨了在编程中优化帮助引导类设计的重要性,并对比了三种不同的实现方式,强调了清晰代码和良好沟通的价值。通过同事的建议,提出将判断逻辑移至全局对象,以增强代码的可读性和维护性。文章总结了沟通在技术进步中的关键作用,以及编程实践中面向可读性的代码编写原则。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

最近参与公司项目,需要编写一个帮助引导用户使用的类。 在调用的时候会生成一个VIEW引导用户。

第一种设计

这个View 第一次被我设计成用GetInstance静态方法在使用的时候创生一个类,这样需要生成的方法内置于对象构造函数之中。

第二种设计

   而后又写了一个静态方法用来判断该类需不需要生成对象。这样就避免了对象不管如何都要构造的问题

       第三次改写

                      将方法名改写, CheckAndShowGuide 这样就方便使用者的理解。阅读代码就会明白内部机制


第三种方法是同事提议的。 将判断放在另外一个一个全局对象中,该对象会保存一些配置。通过调用该全局对象方法来判断是否需要生成帮助引导。

 我得认识是,这个方法放到全局对象里,会导致阅读时候混乱。读代码的人可能会很糊涂那个全局对象里为啥会有这样一个方法
。 内置到帮助引导的类里面 读者会更明白一些。但是这个GetInstance方法需要改名字,  这样阅读代码的时候就会明白这个方法到底是做了什么工作,

自己review的时候也回更明白。



总结如下: 沟通与交流是提高技术与迸发思维的一种手段。 尤其是比自己水平高的人指点。

     编程应面向可读性而写代码。



评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值