`
rensanning
  • 浏览: 3548942 次
  • 性别: Icon_minigender_1
  • 来自: 大连
博客专栏
Efef1dba-f7dd-3931-8a61-8e1c76c3e39f
使用Titanium Mo...
浏览量:38158
Bbab2146-6e1d-3c50-acd6-c8bae29e307d
Cordova 3.x入门...
浏览量:607324
C08766e7-8a33-3f9b-9155-654af05c3484
常用Java开源Libra...
浏览量:682354
77063fb3-0ee7-3bfa-9c72-2a0234ebf83e
搭建 CentOS 6 服...
浏览量:89370
E40e5e76-1f3b-398e-b6a6-dc9cfbb38156
Spring Boot 入...
浏览量:401861
Abe39461-b089-344f-99fa-cdfbddea0e18
基于Spring Secu...
浏览量:69700
66a41a70-fdf0-3dc9-aa31-19b7e8b24672
MQTT入门
浏览量:91724
社区版块
存档分类
最新评论

关于代码风格

 
阅读更多
良好的代码风格能提高代码可读性及可维护性,程序员都应该遵守基本的代码排版规范、代码命名规范。

首先看看以下三张图,在没有代码的情况下能猜猜各是什么开发语言。
---------------------------------------------------------------

---------------------------------------------------------------

---------------------------------------------------------------


第一张图是CSS,可以看到清晰的选择器和属性键值对。
第二张图是HTML,可以看到清晰的head和body定义。
第三张图是Java,可以看到头部imports,类定义,成员变量,构造函数以及其他方法。
图片来自:https://schneide.wordpress.com/2015/04/26/the-typography-of-source-code/

各个语言都有自己的规范,开发所用的各种IDE也都内置了代码格式化工具,比如Eclipse对Java和JavaScript代码的标准格式化定义:





也可以通过 Checkstyle 检查Java代码的规范性。

这里罗列几个最有争议的。

(1)缩进

使用Tab 还是空格?2个空格还是4个空格?具体关于这个网上的争论太多了,但是需要特别注意的是像Python和CoffeeScript等是通过缩进来控制代码逻辑。



https://softwareengineering.stackexchange.com/questions/57/tabs-versus-spaces-what-is-the-proper-indentation-character-for-everything-in-e
https://medium.com/@hoffa/400-000-github-repositories-1-billion-files-14-terabytes-of-code-spaces-or-tabs-7cfe0b5dd7fd

(2)换行

大括号是否应该换行?

if (you.hasAnswer()) {
    you.postAnswer();
} else {
    you.doSomething();
}


if (you.hasAnswer())
{
    you.postAnswer();
}
else
{
    you.doSomething();
}


if (you.hasAnswer())
    you.postAnswer();
else
    you.doSomething();


https://softwareengineering.stackexchange.com/questions/2715/should-curly-braces-appear-on-their-own-line

大括号是否应该省略?

for (int i = 0; i < size; i++)  {
   a += b;
}


for (int i = 0; i < size; i++)  
   a += b;


for (int i = 0; i < size; i++) a += b;


https://stackoverflow.com/questions/8020228/is-it-ok-if-i-omit-curly-braces-in-java

(3)对齐

赋值等号对齐
int a_variable           = 1;
int another_variable     = 2;
int yet_another_variable = 3;


注释对齐
// whole line comment
int linePointer;                            // inline comment
BufferredReader br = new BufferredReader(); // inline comment
File f = new File();                        // inline comment


参数对齐
int some_call_result = some_object.a_method(
        with, 
        quite_long, 
        list_of,
        parameters
    );


链式方法对齐
protected void configure(HttpSecurity http) throws Exception {
  http
    .authorizeRequests()
      .antMatchers("/resources/**", "/signup", "/about").permitAll()
      .antMatchers("/admin/**").hasRole("ADMIN")
      .antMatchers("/db/**").access("hasRole('ADMIN') and hasRole('DBA')")
      .anyRequest().authenticated()
      .and()
    .formLogin();
}


(4)空行

合理的利用空行来区分代码块。
    /**
     * Initialize this servlet.  Most of the processing has been factored
     * into support methods so that you can override particular functionality
     * at a fairly granular level.

     *
     * @throws ServletException if we cannot configure ourselves correctly
     */
    public void init() throws ServletException {
        final String configPrefix = "config/";
        final int configPrefixLength = configPrefix.length() - 1;

        // Wraps the entire initialization in a try/catch to better handle
        // unexpected exceptions and errors to provide better feedback
        // to the developer
        try {
            initInternal();
            initOther();
            initServlet();
            initChain();

            getServletContext().setAttribute(Globals.ACTION_SERVLET_KEY, this);
            initModuleConfigFactory();

            // Initialize modules as needed
            ModuleConfig moduleConfig = initModuleConfig("", config);

            initModuleMessageResources(moduleConfig);
            initModulePlugIns(moduleConfig);
            initModuleFormBeans(moduleConfig);
            initModuleForwards(moduleConfig);
            initModuleExceptionConfigs(moduleConfig);
            initModuleActions(moduleConfig);
            moduleConfig.freeze();

            Enumeration names = getServletConfig().getInitParameterNames();

            while (names.hasMoreElements()) {
                String name = (String) names.nextElement();

                if (!name.startsWith(configPrefix)) {
                    continue;
                }

                String prefix = name.substring(configPrefixLength);

                moduleConfig =
                    initModuleConfig(prefix,
                        getServletConfig().getInitParameter(name));
                initModuleMessageResources(moduleConfig);
                initModulePlugIns(moduleConfig);
                initModuleFormBeans(moduleConfig);
                initModuleForwards(moduleConfig);
                initModuleExceptionConfigs(moduleConfig);
                initModuleActions(moduleConfig);
                moduleConfig.freeze();
            }

            this.initModulePrefixes(this.getServletContext());

            this.destroyConfigDigester();
        } catch (UnavailableException ex) {
            throw ex;
        } catch (Throwable t) {
            // The follow error message is not retrieved from internal message
            // resources as they may not have been able to have been
            // initialized
            log.error("Unable to initialize Struts ActionServlet due to an "
                + "unexpected exception or error thrown, so marking the "
                + "servlet as unavailable.  Most likely, this is due to an "
                + "incorrect or missing library dependency.", t);
            throw new UnavailableException(t.getMessage());
        }
    }


(5)命名

违反命名规范的例子有很多,这里列2个:

非驼峰命名

package com.test.EC_shop;

public class db_manager {
    private String connection_url;

    public void Init() {
       // ...
    }

}


连续编号

public class UC8010 extends CMN0101 {
    private String FLD0001;

    public int MTD0001() {
       // ...
    }

}
publi class UC8020 extends CMN0101 {
    private String FLD0001;

    public int MTD0001() {
       // ...
    }

}



再列举一些代码书写上的其他Style。

(1)多层嵌套 还是 中途退出?

public String getInsuranceName(Employee employee) {
    if (employee != null) {
        Car car = employee.getCar();
        if (car != null) {
            Insurance insurance = car.getInsurance();
            if (insurance != null) {
                return insurance.getName();
            }
        }
    }
    return "UNKNOWN";
}


public String getInsuranceName(Employee employee) {
    if (employee == null) {
        return "UNKNOWN";
    }
    Car car = employee.getCar();
    if (car == null) {
        return "UNKNOWN";
    }
    Insurance insurance = car.getInsurance();
    if (insurance == null) {
        return "UNKNOWN";
    }
    return insurance.getName();
}


(2)常量放在左侧还是右侧?

if (currentValue == 5) {
    // do work
}
if (5 == currentValue) {
    // do work
}


if (obj == null) {
}
if (null == obj) {
}
if (obj = null) { // 赋值运算、NPE异常
}
if (null = obj) { // 编译错误
}


https://stackoverflow.com/questions/2369226/object-null-or-null-object

(3)定义接口类型还是实现类型?

List<Integer> sampleList = new ArrayList<Integer>();


ArrayList<Integer> sampleList = new ArrayList<Integer>();


(4)标准for循环还是增强for循环?

for (int i = 0; i < peopleList.size(); i++) {
  People p = peopleList.get(i);
  // ..
}


for (People p : peopleList) {
  // ...
}


(5)变量是否需要先定义为null?

Object localVariableObj2 = null;
localVariableObj2 = new Object();


Object localVariableObj2 = new Object();


*** 成员变量有默认值不需要赋值null,本地变量没有默认值需要赋值null。

(6)通过class还是interface定义全局常量?

public final class Constants {
  public static final int PI = 3.14;
}


public interface Constants {
  int PI = 3.14;
}


还有这么定义的:
public interface Constants {
  public static final String TOAST = "toast";
}


这些都是常见的,还有很多。
  • 大小: 7.5 KB
  • 大小: 38.3 KB
  • 大小: 13.7 KB
  • 大小: 113.1 KB
  • 大小: 91.8 KB
  • 大小: 19.6 KB
1
0
分享到:
评论

相关推荐

    程序员之路———关于代码风格

    【程序员之路———关于代码风格】的探讨主要集中在代码风格的重要性、代码行极限、缩进方式、折行原则以及空格和空行的使用。这些规范对于任何程序员来说都是提高代码可读性和团队协作效率的基础。 1. **代码行...

    vorlesung_coding_guidelines_ppt.pdf 关于代码风格的

    该文档详细地介绍了代码风格指南,并且详细地阐述了在Verilog编码过程中应该如何遵循命名约定、编码风格以及严重性级别。 ### 命名约定和编码风格 首先,文档强调了文件中只能包含一个模块,这是为了简化源代码...

    swift-关于iOS代码风格管理的两三事儿

    在iOS开发中,保持良好的代码风格对于团队协作和项目的维护至关重要。Swift作为一种强类型、安全且高度可读的编程语言,其代码风格的规范性更显得尤为重要。本篇将深入探讨如何在Swift项目中进行有效的代码风格管理...

    linux内核代码风格

    Linux内核代码风格是一份关于Linux操作系统内核编程的指南,它详细规定了代码的编写习惯,以便提高代码的可读性和可维护性。本知识点将基于给定文档的内容,详细介绍Linux内核代码风格的各个方面。 首先,文档指出...

    verilog code style(代码风格,很有用)

    以下是一些关于Verilog代码风格的重要知识点: 1. **注释**:清晰的注释是任何代码的基础。在模块、接口、函数和关键逻辑部分添加注释,解释其功能和用途。注释应简洁明了,避免过于冗长。 2. **模块结构**:模块...

    用于VS、Vscode、Clion的代码风格文件

    标题中的“用于VS、Vscode、Clion的代码风格文件”指的是为Visual Studio (VS)、Visual Studio Code (Vscode) 和 CLion 这三款流行的集成开发环境(IDE)提供的代码格式化配置文件。这些文件通常包含了特定的规则和...

    IDEA与Eclipse统一代码风格codeformatter使用文档

    在开发团队中,为了确保代码的可读性和一致性,统一代码风格是非常重要的。通常,团队会选择使用流行的集成开发环境(IDE),如IntelliJ IDEA和Eclipse进行开发工作。为了在两个不同的IDE中保持代码风格的一致性,...

    java代码审查表.pdf

    Java代码审查表中关于代码风格和格式规则的重要性激活级别检查项有: * 代码段落是否被合适地以空行分隔?(Y20) * 是否合理地使用了空格使程序更清晰?(20) * 代码行长度是否在要求之内?(20) * 是否折行是否...

    代码阅读方法与实践

    通过《代码阅读方法与实践》这本书,读者不仅可以学到关于代码风格的基础知识,还能了解到如何通过实践来提高代码的质量。本书通过具体的示例分析,强调了良好的代码风格对于软件开发的重要性,并提供了实用的指南来...

    StyleCop(微软代码检查工具)

    1. **代码风格检查**:StyleCop检查一系列关于代码风格的规定,例如命名约定(变量、类、方法等的命名规则)、注释要求(如需包含XML注释)、代码布局(空格、缩进、换行等)以及代码结构(如避免使用嵌套的using...

    阿里代码检查.zip

    通过安装和使用这个插件,开发者可以在编码过程中实时收到关于代码风格和潜在问题的提示,从而及时纠正,提高开发效率。 1. **Intellij IDEA插件安装**: - 打开Intellij IDEA,进入设置(Settings)或首选项...

    Python-Black是一个Python代码格式化程序

    这个工具旨在消除关于代码风格的争论,通过自动格式化Python源代码,使其遵循PEP 8编码规范,从而提升团队协作效率和代码一致性。Black的独特之处在于它的硬性规定,它不提供任何配置选项,而是以一种“零配置”理念...

    Eclipse\CheckStyle代码风格配置文件

    通过以上解释,我们可以理解这个压缩包中的内容是关于Eclipse集成CheckStyle的配置文件和操作指南,对于保持团队代码风格的一致性至关重要。开发者可以根据这些资源轻松地在自己的开发环境中实施代码风格检查。

    Javascript代码检视规范

    关于代码风格,可以参考Airbnb或Google等知名公司提供的JavaScript编码规范。这些规范通常包含对缩进、空格、括号放置等方面的指导,比如使用2个空格作为缩进,函数参数之间和操作符周围添加空格等。 为了自动化...

    编码规范 注释规范 代码风格 JAVA

    在IT行业中,编程规范、注释规范以及代码风格是软件开发中的重要组成部分,尤其是在大型企业如华为这样的公司中,它们被视为保证代码质量、提高团队协作效率的关键准则。这些规范不仅有助于提升代码的可读性和可维护...

    Delphi 代码风格规范

    《Delphi代码风格规范》是指导开发者在使用Delphi编程时遵循的一套约定,旨在提高代码的可读性、可维护性和团队协作效率。本文将深入探讨这些规范,并结合相关资源进行阐述。 首先,规范中强调了命名约定。在Delphi...

    匈牙利命名法---- 好的代码风格是成为优秀程序员的第一步

    ### 匈牙利命名法:好的代码风格是成为优秀程序员的第一步 在软件开发领域,良好的编程习惯与规范是每一个程序员成长道路上不可或缺的部分。其中,匈牙利命名法则是一种广泛应用于C、C++等语言中的变量命名约定,它...

    Linux内核代码风格

    【Linux内核代码风格】是Linux开发中遵循的一套编程规范,旨在确保代码的清晰度、可读性和可维护性。这份文档虽然简洁,但包含了关于缩进、行宽、大括号放置以及空格使用等方面的重要指导原则。 首先,**缩进**是...

    统一文件编码和代码风格,提高代码可读性(eclipse设置)

    "统一文件编码和代码风格,提高代码可读性(eclipse设置)"这个主题聚焦于如何通过Eclipse集成开发环境来实现这一目标。Eclipse作为一个强大的Java IDE,也支持多种其他语言,它提供了丰富的功能来帮助开发者规范...

    规范学习代码

    ╠╣µ╖╢"这个文件名看起来可能是编码错误或者非标准字符,但如果是有效的文件,可能包含了一些特殊或特定的编码规范或者工具,例如可能是对某种编程语言(如Python或Java)的特定指导,或者是关于代码风格或最佳...

Global site tag (gtag.js) - Google Analytics