Java编码规范中文版
Java 的老毛病就是团队风格不统一,代码看着就像多个人写的,嗯,确实是。《Java 编码规范中文版》这份文档还挺靠谱的,基本覆盖了从命名到并发编程的各个环节,不只是给你列规则,还结合了不少实际建议。
命名部分讲得细,比如变量用小驼峰,常量用全大写加下划线,一看就知道有过实际踩坑经验。还有类名、接口名怎么写,看完不容易搞混。
注释这块也提了不少细节,Javadoc怎么写,什么时候该写行内注释,写多少合适。重点是:别废话,别翻译代码——这点说得太中肯了。
类的设计也有建议,比如一个类尽量只负责一件事。还提了单一职责、开闭原则这些面向对象的基本功。其实多人都知道这些原则,但真能做到的挺少。
方法部分我觉得蛮实用的。意思明确:方法别太长,参数别太多,名字别太随意。最好让别人一眼就能猜出干啥的。
异常也没放过,强调不要写空的catch
块,有异常就清楚,别让人猜。再说到finally
,资源释放这事不做真的容易出锅。
并发这块比较实战,推荐用synchronized
和java.util.concurrent
这些现成工具,别自己写锁逻辑,那玩意儿出了问题真是找都找不着。
另外,还有些细节上的最佳实践,比如避免魔法数字、合理使用 null,甚至怎么写import
语句都有讲。可以说是细致到家了。
,这份规范挺适合拿来做团队约定文档的底稿。你是初学者也能看得懂,老司机看了也能点头。推荐收藏。如果你正打算做代码审查、拉团队规范,不妨先看这个。
30.3KB
文件大小:
评论区