Java-Codierungsstandards (häufig verwendete Schlüsselpunkte)

Das Folgende ist die Java-Codierungsspezifikation, die ich zusammengestellt habe. Beim Schreiben von Code müssen Sie die Codierungsspezifikation befolgen, um die tägliche Wartung zu erleichtern.

Namenskonvention

Klassennamenskonvention

Der erste Buchstabe jedes Wortes in der Klasse muss großgeschrieben werden, z. B. UserService, falsche Benennungsmethode userService, userservice

Der Testfall endet mit Test, z. B. UserServiceTest

Wenn Es wird durch den Begriff abgekürzt. Am Anfang sollten alle Begriffsabkürzungen großgeschrieben werden, z. B. HTMLEditor. Falsche Schreibweise...

Klassennamen sollten englische Buchstaben oder Zahlen verwenden und keine Sonderzeichen enthalten

Schnittstellen beginnen nicht mit I

Methodennamenskonvention

Der erste Buchstabe des ersten Wortes ist Kleinbuchstabe und der erste Buchstabe andere Wörter werden groß geschrieben

Sie sollten es am Methodennamen erkennen können. Die Funktion der Methode

Codierungsstandards

Code-Einrückung

Code-Einrückung ist ein Tabulator (Länge von 4 Leerzeichen). Eclipse hat standardmäßig eine Länge von 4 Leerzeichen.

Geltungsbereich

Die Attribute in der Klasse sollten auf privat gesetzt werden, und externe Klassen können private Attribute ändern, indem sie Get- und Set-Methoden bereitstellen.

Wenn die Methode in der Klasse nur für den internen Gebrauch der Klasse bestimmt ist, sollte sie auf privat gesetzt werden; wenn sie von Unterklassen verwendet werden kann, sollte sie auf geschützt gesetzt werden, wenn es sich um eine öffentliche Methode handelt. es sollte auf öffentlich eingestellt werden.

Anmerkungsspezifikationen

Anmerkung zu Urheberrechtsinformationen

Anmerkung zu Urheberrechtsinformationen Wird am Anfang der Datei verwendet, um das Urheberrecht des Codes anzugeben. Verwenden Sie Kommentare wie /**/.

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

Die Kommentarvorlage lautet wie folgt: Fenster->Einstellungen->Java->Codestil->Kommentare->Dateien

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

Copyright © 2015 TIAMAES Inc. Alle Rechte vorbehalten. Die Beschreibung lautet wie folgt:
Copyright 2015 Tianmai Technology Co., Ltd. Alle Rechte vorbehalten.
- Inc. Eine nach dem Gesellschaftsrecht gegründete Aktiengesellschaft
- Co. Ltd Limited Liability Company

Spezifikationen für Klassenanmerkungen

Die Klassenanmerkungsinformationen sollten sein: Enthält Klassenbeschreibungsinformationen, Autoreninformationen und Versionsinformationen.

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

Die Kommentarvorlage lautet wie folgt: Fenster->Einstellungen->Java->Codestil->Kommentare->Typen

/**  
 * ${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编码规范，希望今后大家做开发时能够严格按照编码规则来开发，这样有便于日常维护。

Das obige ist der detaillierte Inhalt vonJava-Codierungsstandards (häufig verwendete Schlüsselpunkte). Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!