小课堂Week11 会说话的代码

小课堂Week11

会说话的代码

今天主要讨论下,在编码过程中和"命名"相关的问题。因为命名方法比较自由,如果要提高可读性,我们需要尽量使其符合正规的英文语法习惯。

变量/属性

通常来说,变量/属性应该是一个名词,比如message。

但有两种特殊情况要注意:
比如如下代码,

    List<Message> getMessageList(String name){
    }

messageList的写法并不好,应该使用复数的名词。

    List<Message> getMessages(String name){
    }

再如下的代码,message信息发生了重复。

    public class Message {
        public int message;
    }

我们可以用代词来表示这种重复。

    public class Message {
        public int what;
    }

对于布尔类型的属性,会用形容词来表示:
对于形容词来说,用一个比较通用的写法,就是加上is~able的前后缀。
比如isSendable。

函数/方法

函数通常来说会采用动宾结构的短语。

让我们看个例子:

列出数学成绩及格的学生

动宾结构是列出学生,其他的是定语,一般采用参数的方式来定义。

    filterStudents(Subject subject,Score min,Score max);

今天开个头,我们下次继续。

posted @ 2016-10-29 10:10  哎哟慰  阅读(174)  评论(0编辑  收藏  举报