Java温习——基础工具之编码规范

Posted 2022-12-13 twc829

一、为什么有编码规范？

1 一个软件的生命周期中，80%花费在维护上（改bug/增加新的功能）；

2 几乎没有任何一个软件，在其整个生命周期中均由最初的开发人员维护；

3 编码规范可改善软件的可读性，可让程序员尽快而彻底地理解新代码；

4 若将源码作为产品发布，需确认其是否被很好地打包且清晰无误；

如开头注释

所有源文件应在开头列出类名、版本信息、日期和版权声明；

/*
 * Classname
 *
 * Version information
 *
 * Date
 *
 * Copyright notice
 */

包和引入语句

在多数Java源文件中，第一个非注释行是包语句，其后是引入语句；如

package java.awt;
import java.awt.peer.CanvasPeer;

二、编码规范

1 明确需求，我要做什么

2 整理思路，我要怎么一步步实现功能（可在注释中写操作步骤）

3 按照思路编写代码

4 功能写完，一定要测试

5 总结该功能是怎么做出来的，以后再遇到该怎样迅速解决

三、起名规范（简单）

起名注重的共通点：

· 都得遵循标识符规范；

· 不能使用拼音或拼音首字母，必须使用英文单词或英文组合单词；

· 采用驼峰表示法；

1 包名

package 域名倒写.模块名.组件;

全部使用小写字母，作为Java文件的第一行代码；

如，package com._520it.pss.util;

2 类名

使用名词，表示一类事物，首字母大写；

在实际项目中，尽量不使用JDK内置类名，如String、System类；

3 接口名

使用形容词/副词/名词，首字母大写；

有的企业习惯以I作为借口的前缀名，如IEmployeeService；

4 方法名

使用动词/动词短语，首字母小写；

5 变量

使用名词，首字母小写；

6 常量

使用final修饰的变量；

全部大写，若单词组合则使用下划线分割，如MAX_VALUE；

在方法中定义的final变量，一般不使用大写；