码农的素养

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

命名问题

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

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

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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,547评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,399评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,428评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,599评论 1 274
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,612评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,577评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,941评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,603评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,852评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,375评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,955评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2 342

推荐阅读更多精彩内容