命名总体原则和概述
- 名字应该能够标识事物的特性,并且与业务挂钩。
- 名字一律使用英文单词,而不能为拼音。
- 名字可以有两个或三个单词组成,但不应多于4个,控制在3至30个字母以内。
- 在名字中,多个单词用大写第一个字母(其它字母小写)来分隔。例如:IsSuperUser。
- 命名避免和以下关键字冲突
如:Base,Date,Class……
- 方法名、参数名统一使用驼峰命名法(Camel命名法),除首字母外,其他单词的首字母大写,其他字母小写,类名每个组合的单词都要大写;
正例:localValue/getHttpMessage()/inputUserId
方法
- 增加/插入的方法用add作为前缀;
正例:add*/addGrade()
- 删除的方法用delete作为前缀;[董1]
正例:delete*/deleteGrade()
- 更改/更新的方法用update作为前缀;
正例:update*/updateGrade()
- 查询/获取单个对象的方法用find作为前缀;
正例:find*/findGrade()
- 查询/获取多个对象的方法用query作为前缀;
正例:query*/queryStudentList()
在具体任务开发中,如果有特定的命名约定,则在相应的软件开发计划中予以明确定义及上报质量管理部审计组。
详情请查看-----xxx代码规范