小发猫

【小发猫】基于AI的NLP伪原创工具

【飞鸽传书】往往会说其应当具备可维护性

对于一个好的设计,【飞鸽传书】往往会说其应当具备可维护性,这是最为基本的要求。其它的要求,比如性能、资源的占用等都应当在满足可维护性的情况下再去考虑的。但可维护性是一个非常笼统的词,可以说一个词包含了很多的东西,比如,可读性、可扩展性等等,都可以当作是可维护性的内容。我在日常工作中,对于一个好的设计,有一些自己的想法,主要是体现在“四性一痛”。

一个好的设计应当具有“一致性”。一致性就是对于相类似的问题采用同样的方法去处理,而不是对于类似的情况,在case1中采用的是设计A,而在case2中采用的是设计B。对于这种设计,其往往很难维护。需要说明的一点是,一致性可以包括设计方法的一致性、函数命名的一致性、注释书写格式的一致性等等。

在一致性上一个好的例子是:UNIX/LINUX中对于文件和设备的处理都是采用open()/close()/ioctl()/read()/write()这五个函数来实现的,当飞鸽传书在UNIX/LINUX上编程时,只要说到打开设备或是文件,飞鸽传书就知道应当如何做了。再来看看一致性不好的一个例子:比如CLIB中的malloc()/free(),这是一对用于分配和释放内存(Heap)的函数,在函数的命名上应当说其一致性并不好,在我看来malloc()/mfree()就要比它好些,不同之处就是在free()函数名的前面加了一个m。一致性好的软件,不论是维护或是阅读都让人觉得舒服和自然,这一点是非常重要的!

阅读更多
想对作者说点什么? 我来说一句

没有更多推荐了,返回首页

加入CSDN,享受更精准的内容推荐,与500万程序员共同成长!
关闭
关闭