编写代码最应该做好的事情是什么?(备战2022春招或暑期实习,每天进步一点点,打卡100天,Day8)

简介: 编写代码最应该做好的事情是什么?(备战2022春招或暑期实习,每天进步一点点,打卡100天,Day8)

备战2022春招或暑期实习,祝大家每天进步亿点点!Day8

本篇总结的是 《编写代码最应该做好的事情》,后续会每日更新~

关于《Redis入门到精通》、《并发编程》等知识点可以参考我的往期博客:《Redis从入门到精通》系列 《并发编程》系列

相信自己,越活越坚强,活着就该逢山开路,遇水架桥!生活,你给我压力,我还你奇迹!image.png1、简介

著名的图灵奖得主:尼古拉斯·沃斯,提出一个著名的等式:程序 = 算法 +数据结构。因此我们程序员应该花精力做好学好算法和数据结构,但是这并不是我们编写代码时最应该做好的事情;因为在99.99%的场景下,不需要我们来设计算法和实现数据结构(即便是一般的算法工程师也是如此)。


所以在实际开发中,我们编写代码最应该做好的事情是什么呢?

小捌认为是良好的命名规范和详细的代码注释,这两个看似简单的问题,但是想要做好真的太难太难了,以至于很多年老开发写的代码都会出现命名不规范,代码注释不全甚至没有注释的情况;因此这篇文章我们先来盘一盘Java程序员应该如何做好程序命名。


2、正文

2.1 目标


将Java程序的命名规范做好,需要达到的目标总结起来就只有四个字——望文生义。达到这个目标的命名能够让程序具有“自解释”的功能,仅仅从名字上就能理解某个包、类、方法、变量的含义,这样也可以缩减后续注释的工作量。这样的代码传阅给其他程序员时,也便于阅读和维护。


2.2 包


关于包名的命名有两个大致方向:


标准类库

用户类库

标准类库

在Java体系中,标准类库的命名涉及到java、javax等命名,这些命名是由定规范的人定的,因此人家想怎么玩就怎么玩,在核心类库rt.jar包下可以查看。

image.png除了包的前缀之外的其余部分,需要满足尽可能使用单个单词,比如time、security、math;也可以使用缩写,比如awt、io、sql。


不建议包名超过8个字母、不建议使用复数。



2.3 类


类由很多种,比如接口、抽象类、枚举类、普通类等等,这些类在命名上有相同点,也有不同点。


相同点:


类名统一使用驼峰命名法则(大驼峰),比如HttpClient、HttpResponse、HttpRequest

类名具有复数形式可以使用复数命名

禁止使用拼音,即便是国际通用的拼音命名,比如alibaba、youku也不建议出现在类名命名中

不同点:


接口命名一定要要言简意赅,这样的命名其实现类可以很好的包含接口的命名,比如Map、Set、List

枚举类必须使用Enum结尾

抽象类必须使用Abstract开头,比如AbstractMap、AbstractSet;也可以使用Base,比如BaseCalendar、BaseRowSet,建议使用Abstract。

2.4 变量


变量的命名遵守小驼峰命名,在名称中要体现具体的业务,描述变量的用途。千万不要学源码搞那些单个字母的命名,比如这种:image.png此外要注意变量名尽量不要使用is开头,比如isRemoved、isDeleted,因为这种命名往往在序列化场景中,被框架方向解析时错误的认为是removed和deleted,相信这种坑大家都踩过。最好的办法就是完全不用。


2.5 常量


常量就是在作用域内保持不变的值,常量一般用final关键字修饰。常量有很多种分别是全局常量、包内常量、类内常量、局部常量等等。


全局常量:(包内常量、类内常量都一样)

全局常量值得是访问修饰符为public,通常用public static final修饰,这种常量威力巨大,任何地方都可以访问,因此我们一定要把命名做好。


全局常量命名必须全部使用大写字母,如果是多个单词用下划线隔开,拿Java的BigDecimal来举例.

单个单词的常量:

image.pngimage.png

目录
相关文章
|
5月前
|
NoSQL 算法 Linux
秋招无望,五个C++项目助你上岸(可以写进简历)
秋招无望,五个C++项目助你上岸(可以写进简历)
|
21天前
|
缓存 负载均衡 前端开发
【前端实习生备战秋招】—前端性能优化篇,建议收藏
【前端实习生备战秋招】—前端性能优化篇,建议收藏
|
5月前
|
消息中间件 NoSQL Java
做好这4点,面试嘎嘎猛~
做好这4点,面试嘎嘎猛~
28 0
|
架构师 Java 程序员
IT职场生活工作感悟
本文分享了一些IT的学习网站,交流了一些职场心得,最后希望职场人都能发展顺利。
133 0
IT职场生活工作感悟
|
消息中间件 设计模式 Kubernetes
【面经分享】-一年工作经验阿里三面
【面经分享】-一年工作经验阿里三面
【面经分享】-一年工作经验阿里三面
程序人生 - 如何让简历中的「项目经验」更出众?
程序人生 - 如何让简历中的「项目经验」更出众?
316 0
程序人生 - 如何让简历中的「项目经验」更出众?
|
开发者
学姐分享:在求职路上少走一些弯路
作者:悯缘,阿里巴巴,TEDx分享嘉宾
10378 0
学姐分享:在求职路上少走一些弯路
|
网络协议 NoSQL 关系型数据库
【模拟面试-半年实习】项目经验不突出,如何让面试官「眼前一亮」
今天给大家带来另一个读者 —— L同学的故事 L同学专科毕业后只有半年手机系统测试的实习经验,后面专升本后希望找一份12K左右的工作,但苦于项目经验实在是太「单薄」了,所以不知道如何针对性「面试+学习」,所以他找到我,希望我给他进行1次线上模拟面试,今天给大家一起分享一下L同学的故事。
【模拟面试-半年实习】项目经验不突出,如何让面试官「眼前一亮」
|
SQL 缓存 NoSQL
冲刺金三银四,这份豪礼【面试锦囊】真舍不得给你们
大家好,我是小羽马上就是金三银四啦,最近有很多粉丝跟我交流关于面试方面的经验以及分享,也有部分是在准备今年的金三银四的春招。小羽也一直没出关于面试方面的文章,这篇就结合自己之前的面试经历以及...
150 0
冲刺金三银四,这份豪礼【面试锦囊】真舍不得给你们