以下是我整理的Java 编码标准。编写代码时，应遵循编码标准，以方便日常维护。
命名约定
类命名约定
类中每个单词的首字母必须大写（UserService、错误命名userService、userservice等）
测试用例以Test 结尾，例如UserServiceTest
如果术语缩写以缩写开头，则必须大写，例如HTMLEditor 拼写错误。
类名应包含英文字母或数字，不应包含特殊字符。
界面不以I 开头
方法命名约定
第一个单词的首字母小写，其他单词的首字母大写。
方法名称应该告诉您该方法的作用。
编码标准
代码缩进
该代码缩进一个制表符（四个空格）。 Eclipse 的默认长度是4 个空格。
范围
类内的属性必须设置为私有，外部类可以通过提供get 和set 方法来修改私有属性。
如果类中的方法仅供类内部使用，则应将其设置为私有。如果是public方法，如果可以被子类使用就应该设置为public。
注释规范
版权信息注释
版权信息注释在文件的开头，以声明代码的版权。使用/**/等注释。
/*
* 版权所有 2015 TIAMAES Inc. 保留所有权利。
*/
包com.tiamaes.gjds.das.controller；
评论模板为：窗口-首选项-Java-代码样式-注释-文件
/*
* 版权所有 ${year} TIAMAES Inc. 保留所有权利。
*/
版权所有 2015 TIAMAES Inc. 保留所有权利。
版权所有2015 天麦科技有限公司保留所有权利。
– 有限公司根据公司法设立的股份公司。
– 有限公司
类注解规范
类注释信息必须包括类描述信息、作者信息和版本信息。
/**
* 类描述
*@作者王成宇
* @1.0 或更高版本
*参见@xxx
*/
公共类类型名称
评论模板为：窗口-首选项-Java-代码样式-注释-类型
/**
* ${待办事项}
*@作者王成宇
* @1.0 或更高版本
*/
类描述：直接用一行描述该类的功能。如果您需要多行，请使用它。
@author：多个作者使用多个@author
@since：表示这个类是从哪个版本开始的
@see：与该类相关的其他类或方法
请参阅org.springframework.stereotype.Controller 的类注释信息。
/**
* 表示带注释的类是“控制器”（例如，Web 控制器）。
*
* 此注释作为{@link Component @Component} 的特化。
* 允许通过类路径扫描自动发现实现类。
* 这通常与带注释的处理程序方法结合使用。
* {@link org.springframework.web.bind.annotation.RequestMapping}注释。
*
* @作者Arjen Poutsma
* @作者尤尔根·霍勒
* @2.5 或更高版本
* @seeComponent
*参见@org.springframework.web.bind.annotation.RequestMapping
*参见@org.springframework.context.annotation.ClassPathBeanDefinitionScanner
*/
方法注释
请使用下面的模板
/**
* ${待办事项}
* ${标签}
*/
${tags}：自动生成参数、异常、返回值等注解。
/**
*去做
* @参数请求
* @抛出IOException
*/
@RequestMapping(\\\’/ctx\\\’)public void test(HttpServletRequest request) 抛出IOException
如果类中的方法实现了抽象方法或重写了父类中的方法，则必须在该方法上添加@Override注解。如果想重写父类方法上的注解，可以使用/** */注解来重写父类方法上的注解。
org.springframework.core.io.Resource
/**
* 返回该资源的文件句柄。
* 如果资源不能被解析为绝对资源，则抛出IOException
* 如果文件路径（即资源）在文件系统中不可用
*/
文件getFile() 抛出IOException。
在实现的方法中使用/**.*/来覆盖父类方法的注解。
org.springframework.core.io.AbstractResource
/**
* 此实现抛出FileNotFoundException，如下所示：
* 资源无法解析为绝对文件路径。
*/
@Overridepublic File getFile() 抛出IOException {
throw new FileNotFoundException(getDescription() + \\\’ 无法解析为绝对文件路径\\\’);
}
对属性、变量和方法中的代码进行注释
使用//注释变量和属性。另外，在方法内的代码中使用//注释。
如果不需要变量和属性，则不能添加注释。如果你的代码中有负责任的逻辑，你应该使用//注释来解释它。
public ServletContextResource(ServletContext servletContext, String path) { //检查ServletContext
Assert.notNull(servletContext, \\\’无法在没有ServletContext 的情况下解析ServletContextResource\\\’); this.servletContext=servletContext;
Assert.notNull(path, \\\’路径为必填项\\\’);
String pathToUse=StringUtils.cleanPath(path);
if (!pathToUse.startsWith(\\\’/\\\’))
{
使用路径=\\\’/\\\’ + 使用路径；
}
this.path=使用路径；
}
以上是我整理的一些Java编码标准。如果在以后的开发中严格遵循编码规则，日常维护会更加容易。
本文和图片来自网络，不代表火豚游戏立场，如若侵权请联系我们删除：https://www.huotun.com/game/669737.html