码农的素养

积累日常遇到的编码规范,良好的编码习惯,持续更新。。。

命名问题

编码时对类,方法,变量,常亮命名法应遵循:能直观表达其意义!

  • 驼峰命名法:书写时,每个单词的首字母大写。(大驼峰小驼峰和全驼峰都是我自己取的名字)
    • 大驼峰 :每个单词首字母都得大写。 如:UpperCamelCase
    • 小驼峰:首个单词全小写,后续所有单词首字母大写。如:lowerCamelCase
    • 全驼峰:所有单词全大写,单词之间以“_”分隔。如:CAMEL_CASE
  • 匈牙利命名法:开头字母用变量类型的缩写,类型+大驼峰。
    如:int iStudentAge = 0;

类的命名:

类的命名遵循大驼峰命名规则,并且清晰表达类的作用与分类

  • 功能类和接口类:像这种常用类,遵循大驼峰命名规范,表达清楚类的功能即可。
  • 抽象类: 以Abstract 或 Base 开头 。如:AbstractPerson活BasePerson
  • 异常类: 以Exception结尾。如:NoNameException
  • 接口实现类: 以[接口名]+Impl结尾。如:MusicProvider -> MusicProviderImpl
  • 测试类:以它要测试的类的名称开始,以 Test 结尾。 如:MusicProviderImplTest

变量命名:

变量的命名遵循匈牙利命名法。但是也不需要刻意的使用。注意以下几点即可:

  • 全局变量和布局变量区分:全局变量最好以m开头。局部变量表明意思即可。
  • 静态变量:以s开头。
  • 常量用全驼峰命名。
  • boolean值的变量,最好不要简单的以is开头,而是表明逻辑。如:
    boolean studentIsNoName = true;

方法命名

方法的命名遵循小驼峰,力求表达清楚方法功能。

  • 获取单个对象的方法用 get 做前缀。 getName()
  • 获取多个对象的方法用 list 做前缀。 listName()
  • 获取统计值的方法用 count 做前缀。 countStudent()
  • 插入的方法用 add 或 insert 做前缀。 addStudent(Student student)
  • 删除的方法用 remove 或 delete 做前缀。 removeStudent(Student student)
  • 修改的方法用 update 或 change 做前缀 updateStudent(Student student ,String name)
  • 判断布尔值的方法,命名为is 做前缀 isEmpty();
  • 将对象转换为某个特定类型的方法应该命名为to 做前缀 toString()
public class Study {
    private int mAge = 0;
    private String mName = "";
    private int mID = 0;
    private final int FULL_SCORE = 100;

    public Study(int age, String name, int id) {
        mAge = age;
        mName = name;
        mID = id;
    }

    public int getScore(int id) {
        int score = 0;
        if (id == 100) {
            score = FULL_SCORE;
        }
        return score;
    }
}

虽然代码能成功运行是最终目的,但是我们也要保持程序员的基本素养,至少让自己的代码变得逻辑更清晰,通俗易懂。在追求艺术的道路上,我也在不断的学习。

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容