十二、编码规约
2021/11/7 23:10:31
本文主要是介绍十二、编码规约,对大家解决编程问题具有一定的参考价值,需要的程序猿们随着小编来一起学习吧!
编码规约
- 命名风格与代码格式
- 命名体现代码元素特征
- 命名最好望文知义
- 代码格式与设计规约
- 注释规约
命名风格与代码格式
命名体现代码元素特征
- 抽象类命名开头使用Base或Abstract
- 异常类使用Exception结尾
- 测试类以Test结尾
- 类型与中括号相连表示数组
- 枚举类名带上Enum后缀,成员名称大写,单词间下划线隔开
命名最好望文知义
- 不要使用表意不明的缩写(Condition->Condi)
- 不要使用拼音表示
代码格式与设计规约
- 大代码段不要写在一行里,否则会导致代码结构不明晰
- 禁止使用魔法值,敞亮必须定义static final 变量并规定好范围(命名做到表意)
- 常量使用大写字母,并用下划线分割
注释规约
- 写必要的注释,避免大量从方法名中就能很清楚理解的无用注释
- 写出代码中需要特别注意的事项,避免后人踩坑
- 写清复杂程序的执行流程,保持条理清楚
这篇关于十二、编码规约的文章就介绍到这儿,希望我们推荐的文章对大家有所帮助,也希望大家多多支持为之网!
- 2024-07-02springboot项目无法注册到nacos-icode9专业技术文章分享
- 2024-06-26结对编程到底难不难?答案在这里
- 2024-06-19《2023版Java工程师》课程升级公告
- 2024-06-15matplotlib作图不显示3D图,怎么办?
- 2024-06-1503-Loki 日志监控
- 2024-06-1504-让LLM理解知识 -Prompt
- 2024-06-05做软件测试需要懂代码吗?
- 2024-06-0514-ShardingSphere的分布式主键实现
- 2024-06-03为什么以及如何要进行架构设计权衡?
- 2024-05-31全网首发第二弹!软考2024年5月《软件设计师》真题+解析+答案!(11-20题)