关于如何写出好代码的通用建议
选好函数名是写出好代码的重要一环。给函数命名时,可以参考下面这些建议。
给函数命名时,要清楚它到底做什么。例如,函数get(studentId, subject)的函数名就没有意义,因此看不出它具体做什么。它可能在获取学生的科目成绩,也可能在获取他们的选课状态。更好的名字是getStudentGrade(studentId, subject),它准确地表达了这个函数的作用。
注意别把函数名起得太长。例如,checkStudentFailOrPassOrMeritOrDistinction(mark)就是个长得没必要的函数名。名字越长,越难记住,在电脑屏幕上占的地方也越大。
反过来,函数名太短同样会让阅读代码的人困惑。例如,checkFPMD(mark)就是个糟糕的函数名,因为一眼看不出“FPMD”是什么意思。
函数名应该让每个读你代码的人都能看懂。例如,DeathStar()这样晦涩的函数名也许让你觉得有趣,但它没有表达出这个函数的目的,还会让读你代码的其他开发者感到困惑。
对做同一件事的操作,要坚持用同一种命名约定。例如,如果你把获取学生姓名的函数命名为getStudentName(),那么获取学生成绩的函数就不该换用另一个动词(比如retrieveStudentGrade())。
例如,如果你已经用add表示两个数字相加,那么想把一组元素放进集合时,就不要再接着用add了。改用insert或append。