美文网首页
码农的素养

码农的素养

作者: IT废柴 | 来源:发表于2017-12-14 10:24 被阅读0次

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

命名问题

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

  • 驼峰命名法:书写时,每个单词的首字母大写。(大驼峰小驼峰和全驼峰都是我自己取的名字)
    • 大驼峰 :每个单词首字母都得大写。 如: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;
    }
}

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

相关文章

  • 码农的素养

    积累日常遇到的编码规范,良好的编码习惯,持续更新。。。 命名问题 编码时对类,方法,变量,常亮命名法应遵循:能直观...

  • 【绕口令】: 码农画蚂

    码农画蚂 妈妈码头饮马,码农码码画蚂,手麻喊妈,妈见码农蚂,指码,蚂...

  • 我想做个码农

    我想做个码农。 那些攻城狮常常拿码农自嘲,其他职业看攻城狮赚钱多眼红的也叫他们码农。 码农挣得钱多,因为很累,经常...

  • spring IOC

    依赖 码农需要电脑才能敲代码,在这个码农类中,码农持有电脑的引用,所以说码农依赖电脑。依赖是一种关系。 依赖注入 ...

  • 码农周刊总结

    更新记录 正文 码农周刊: issues 码农周刊汇总: Github

  • 一个好码农的八个特质

    引言: 什么样的码农是一个好的码农?估计每个码农都有自己的观点和看法。作为一个至今奋斗在一线的老码农,也带领过几个...

  • 小码匠算法之旅: 第一个算法

    老码农:今天咱们学点新东东。 小码匠:啥新东西啊? 老码农:算法。 小码匠:算法是什么东西啊。 老码农:算法不是东...

  • 我是一个码农

    我是一个码农。 关注公众号:码农和果园

  • 苹果悄然更新App Store审核指南:开箱子要公布掉率

    码农视界,码农看世界! 苹果悄然更新App Store审核指南:开箱子要公布掉率 码农视点 数钱的日子到头了。 分...

  • 码农日报(2014/07/23)

    码农日报由码农IO出品,每天为你精选值得程序员阅读的IT技术干货。订阅 RSS | 在线投稿 《码农周刊》干货精选...

网友评论

      本文标题:码农的素养

      本文链接:https://www.haomeiwen.com/subject/zwshwxtx.html