初入编程行当,代码写的又脏又乱。代码总会越写越多,项目越来越大。杂乱的代码不利于他人维护不说,自己回来看也是一头雾水,这样是很不利于持续开发的。
经师傅指点,获书一本,研读收益,于此笔记。
什么是整洁的代码?这个各有各的理解。我的理解就是,易于理解、易于维护。至于高效那是另一方面的事了。它很难一蹴而就,通常经过多次修改维护才能整洁起来。
从命名说起:
无论是变量、参数、函数、类、包,都应该能从名字了解到它是什么或者要做什么。要避免短的、无意义的命名,如“str1”。两个名字的区分要清晰,冗余的字符不要放到名字里,比如给一个list起名叫“AddressList”。名字应该是能够读的出来的,方便沟通。如果通过注释才能了解一个名字或者一段代码要做什么,那就是失败的代码。
再说函数:
函数应该尽可能的短小,且专注于完成一件事。函数的参数也应该控制在一两个,如果参数过长,那可以考虑封装为一个类了。尽量不要返回null,可以抛出异常,不要返回错误码。