Java コーディング標準 (一般的に使用される重要なポイント)

以下は私がまとめた Java コーディング標準です。コードを記述するときは、日常のメンテナンスを容易にするためにコーディング標準に従う必要があります。

命名規則

クラスの命名規則

UserService、間違った命名方法userService、userserviceなど、クラス内の各単語の最初の文字は大文字にする必要があります

テストケースUserServiceTest などのテストの終了です

用語の略語で始まる場合は、HTMLEditor など、用語の略語をすべて大文字にする必要があります 間違った書き方...

クラス名には英語の文字または数字を使用する必要があり、特殊文字は使用できません表示されます

インターフェイスは I で始まりません

メソッドの命名規則

最初の単語の最初の文字は小文字であり、他の単語の最初の文字は大文字です

関数が表示されるはずですメソッド名からメソッドの説明

コーディング規約

コードの省略形

コードをタブ（スペース4つ分）にインデントします。 Eclipse のデフォルトの長さは 4 スペースです。

スコープ

クラス内の属性はプライベートに設定する必要があり、外部クラスは get メソッドと set メソッドを提供することでプライベート属性を変更できます。

クラス内のメソッドがクラスの内部使用のみを目的とする場合は、プライベートに設定する必要があります。サブクラスで使用できる場合は、パブリック メソッドの場合は、保護するように設定する必要があります。公開します。

コメント仕様

著作権情報アノテーション

著作権情報アノテーションは、コードの著作権を宣言するためにファイルの先頭にあります。 /**/ のようなコメントを使用します。

/* 
 * Copyright ©  2015 TIAMAES Inc. All rights reserved.
 */
package com.tiamaes.gjds.das.controller;

コメントテンプレートは以下の通りです、 ウィンドウ→設定→Java→コードスタイル→コメント→ファイル

/*
* Copyright ©  ${year} TIAMAES Inc. All rights reserved.
*/

Copyright © 2015 TIAMAES Inc. All Rights Reserved 説明は以下の通りです。
Copyright 2015 TIAMAES Technology Co., Ltd. 全著作権所有。
- Inc. 会社法に基づいて設立された株式会社
- Co. Ltd 合同会社

クラスアノテーション仕様

クラスアノテーション情報には、クラスの説明情報、作成者情報、バージョンが含まれる必要があります情報。

/**  
 * 类描述
 * @author 王成委
 * @since 1.0
 * @see xxx
 */
public class TypeName

コメントテンプレートは次のとおりです。ウィンドウ->設定->Java->コードスタイル->コメント->タイプ

/**  
 * ${todo}
 * @author 王成委
 * @since 1.0
 */

类描述：描述类的功能，单行直接写，如果多行需要使用e388a4556c0f65e1904146cc1a846bee94b3e26ee717c64999d7867364b1b4a3

@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 中国語 Web サイトの他の関連記事を参照してください。