电(diàn)话:0535-6589222
邮箱:2438084250@qq.com
网址:www.blog.weihai.cd.xinxiang.zz.pingliang.ww38.viennacitytours.com
地址:烟(yān)台市芝(zhī)罘区金长城大厦12F
在烟台软件开发技(jì)术人员中,有不少写代码总是只按喜欢按自己的(de)习惯(guàn)写,但是如果这(zhè)个产品永远是(shì)你自己一个(gè)人来(lái)写和维护,那么问题不大,那么(me)如果是有很多(duō)人协(xié)作,那么麻烦就大了(le),我(wǒ)相信有很多人说(shuō)了很多代码规范的重要(yào)性,我今天在这里只提(tí)两点意义。
可读性
代码规(guī)范的目的就是保(bǎo)持可读(dú)性。
其实,明白了可读性重(chóng)要后,是有一些方法(fǎ)来提高可读性的(de)。
1.自己每(měi)写完一(yī)段代码,至(zhì)少读三遍,看看是否(fǒu)能够(gòu)明白,知道为什么要这么写和自己(jǐ)是怎么写的(de)。
2.代码写完了,可以让别人看你的代(dài)码,就(jiù)看那一个方法,不要太多上下文,如果别人能够明(míng)白(bái),就是很不错的(de)。如果不(bú)明(míng)白,可能是命名(míng)不(bú)对,或者if,else太(tài)多(duō)大家被绕进(jìn)去了。
3.好(hǎo)的代(dài)码光看(kàn)类名就知道类是做什么的(de),光看方法(fǎ)名就知道这一(yī)个方法解决哪一个具体(tǐ)问题(单一职责)
4.写单元测试,如果代码测试(shì)覆盖率好(hǎo),可读性也更(gèng)好,前提(tí)是(shì)单元(yuán)测试要(yào)写(xiě)好。
5.可(kě)读性(xìng)好的代码,任何人也都可(kě)以帮忙写单元测试。
可维护(hù)性(xìng)
代码规(guī)范(fàn)的另一个主要(yào)目的就(jiù)是可维(wéi)护性。
可维护性就是:how easily a system can be modified
这个可维护(hù)性一定(dìng)还是(shì)基(jī)于代码的可读(dú)性上,在(zài)可维护性方面有(yǒu)几个实(shí)践记得参考。
1.写(xiě)代码的时候(hòu)一定要觉(jiào)得我做的产品将来(lái)我会维护,当然肯定不全是,但是做的时候要这么思考。
2.保持一个(gè)廉(lián)耻心(xīn),心里想着如果代码不(bú)是(shì)我维护,将来千(qiān)万不要改代码的(de)时候让别人问候我的家人。
3.使用大家熟悉的技术或者通用的技术。
4.使用大(dà)家常用的一些结(jié)构比如MVC, MVVM等(děng)等。
5.使用一些好的实践(jiàn)比如单元(yuán)测试 (修改(gǎi)代码的时候(hòu)就不怕破(pò)坏隐(yǐn)藏的功能)
6.留下必(bì)要的文档(dàng)。
7.项目相关的东西集中在一起。