다음은 제가 컴파일한 Java 코딩 표준입니다. 코드를 작성할 때 일상적인 유지 관리가 용이하도록 코딩 표준을 따라야 합니다.
네이밍 규칙
클래스 네이밍 규칙
UserService, 잘못된 네이밍 방법 userService, userservice
테스트 케이스 UserServiceTest 와 같이 Test Ending 입니다
용어 약어로 시작하는 경우 HTMLEditor 와 같이 용어 약어를 모두 대문자로 표기해야 합니다. 틀린 표기...
클래스 이름은 영문 또는 숫자를 사용해야 하며, 특수문자는 사용하지 않아야 합니다. appear
인터페이스는 I
로 시작하지 않습니다. 메서드 명명 규칙
첫 번째 단어의 첫 글자는 소문자, 다른 단어의 첫 글자는 대문자입니다
함수를 볼 수 있어야 합니다. 메소드 이름
Codingstandards
코드 약어
코드를 탭(공백 4칸)에 들여쓰기합니다. Eclipse의 기본값은 공백 4개입니다.
Scope
클래스의 속성은 비공개로 설정되어야 하며 외부 클래스는 get 및 set 메서드를 제공하여 비공개 속성을 수정할 수 있습니다.
클래스의 메소드가 클래스 내부 전용인 경우 비공개로 설정해야 하며, 하위 클래스에서 사용할 수 있는 경우 공개 메소드인 경우 보호로 설정해야 합니다. 대중에게.
댓글 사양
저작권 정보 댓글
저작권 정보 댓글은 코드의 저작권을 선언하기 위해 파일 시작 부분에 있습니다. /**/와 같은 주석을 사용하세요.
/* * Copyright © 2015 TIAMAES Inc. All rights reserved. */ package com.tiamaes.gjds.das.controller;
댓글 템플릿은 다음과 같습니다. Window->Preferences->Java->Code Style->Comments->Files
/* * Copyright © ${year} TIAMAES Inc. All rights reserved. */
Copyright © 2015 TIAMAES Inc. 설명은 다음과 같습니다.
저작권 2015 (주)티아마스테크놀로지 All Rights Reserved.
- Inc. 회사법에 따라 설립된 주식 유한 회사
- Co. Ltd 유한 책임 회사
클래스 주석 사양
클래스 주석 정보에는 클래스 설명 정보, 작성자 정보 및 버전이 포함되어야 합니다. 정보.
/** * 类描述 * @author 王成委 * @since 1.0 * @see xxx */ public class TypeName
댓글 템플릿은 Window->Preferences->Java->Code Style->Comments->Types
입니다./** * ${todo} * @author 王成委 * @since 1.0 */
类描述:描述类的功能,单行直接写,如果多行需要使用
@author:多个作者使用多个@author
@since:说明此类是从那个版本开始
@see:与类相关的其他类或方法
可参考org.springframework.stereotype.Controller的类注释信息。
/** * Indicates that an annotated class is a "Controller" (e.g. a web controller). * * <p>This annotation serves as a specialization of {@link Component @Component}, * allowing for implementation classes to be autodetected through classpath scanning. * It is typically used in combination with annotated handler methods based on the * {@link org.springframework.web.bind.annotation.RequestMapping} annotation. * * @author Arjen Poutsma * @author Juergen Hoeller * @since 2.5 * @see Component * @see org.springframework.web.bind.annotation.RequestMapping * @see org.springframework.context.annotation.ClassPathBeanDefinitionScanner */
方法注释
使用下面的模版
/** * ${todo} * ${tags} */
${tags}:自动生成参数、异常、返回值等注解
/** * TODO * @param request * @throws IOException */ @RequestMapping("/ctx")public void test(HttpServletRequest request) throws IOException
如果类中的方法实现了抽象方法或重写了父类的方法,应在方法上加上@Override注解。如果要覆盖父类方法的注释可以使用/** */注释来覆盖父类的注释。
org.springframework.core.io.Resource /** * Return a File handle for this resource. * @throws IOException if the resource cannot be resolved as absolute * file path, i.e. if the resource is not available in a file system */ File getFile() throws IOException;
在实现的方法上使用/**...*/可以覆盖父类方法的注释。
org.springframework.core.io.AbstractResource /** * This implementation throws a FileNotFoundException, assuming * that the resource cannot be resolved to an absolute file path. */ @Overridepublic File getFile() throws IOException { throw new FileNotFoundException(getDescription() + " cannot be resolved to absolute file path"); }
属性和变量及方法内代码的注释
使用//来对变量和属性注释,方法内的代码也使用//注释
如非必要变量和属性可以不加注释,如果代码内有负责逻辑应使用//注释加以说明
public ServletContextResource(ServletContext servletContext, String path) { // check ServletContext Assert.notNull(servletContext, "Cannot resolve ServletContextResource without ServletContext"); this.servletContext = servletContext; // check path Assert.notNull(path, "Path is required"); String pathToUse = StringUtils.cleanPath(path); if (!pathToUse.startsWith("/")) { pathToUse = "/" + pathToUse; } this.path = pathToUse; }
以上是我所整理的一部分JAVA编码规范,希望今后大家做开发时能够严格按照编码规则来开发,这样有便于日常维护。
위 내용은 Java 코딩 표준(일반적으로 사용되는 핵심 사항)의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!