`

代码书写规范

 
阅读更多

 

有人说好的代码是重构出来,很认同,我还觉得好的代码是在写代码的过程中不停思考、借鉴、模仿、总结、坚持出来的。

好的代码:流程清晰,注释友好,命名规范,格式合理,异常处理恰当。

 

 

一、

 

for(int i=0;i<list.size();i++){
}

for(int i=0,int len=list.size();i<len;i++){
}

 

 

二、

 

for(int i=0;i<100;i++){
        Object obj = new Object();
}

Object obj = null;
for(int i= 0;i<100;i++){
         obj = new Object();
}

 

 

三、 惯用法应该写成isEmpty 语义上更好一些。对于需要判断集合大小的情况,为了代码的可读应采用Extract Method手法,即抽出一个方法 exist_only_one_item(userList),而不是userList.size()==1 ,userList.size()<2。 

 

if (userList.size()==0){ 
     ... 
 } 

 if (userList.isEmpty()){ 
     ... 
}

if ( userList==null || userList.isEmpty() ) { 

} 
 

 

四、如果A是接口的返回值,此时A实例未赋值,调用该方法需要判断null,否则出现异常。

     接口应该返回empty array,而非null。

     异常如果被捕获,则返回null是一个接口行为。如果没有被捕获,则向上抛。 不论那种情况,这个new都是没有什么        用。

 

A a=new A();
if(condition){
  a=getAFrom();
}else{
   a=getAFrom();
} 


A a=null;
if(condition){
  a=getAFrom();
}else{
  a=getAFrom();
} 

 

总结:具体问题具体分析,但代码一定要符合公司定义的规范,做到统一,否则一个人一种规范,乱套了。

 

分享到:
评论

相关推荐

    PHP代码书写规范

    【PHP代码书写规范】 PHP代码书写规范是为了提高代码可读性、可维护性和团队协作效率而设立的一套指导原则。这些规范涵盖了文件命名、变量、常量、函数、类以及编码格式等多个方面。遵循这些规范,可以帮助程序员...

    C++语言代码书写规范

    ### C++语言代码书写规范详解 #### 概述 C++是一种广泛应用的编程语言,在软件开发领域占有举足轻重的地位。为了确保代码的一致性、可读性和可维护性,制定一套统一的代码书写规范至关重要。本文档旨在提供一份...

    源代码书写规范

    源代码书写规范是编程实践中的一项重要准则,旨在提高代码的可读性、可维护性和一致性。良好的代码规范能够使得开发者之间的协作更为顺畅,减少因理解差异导致的沟通成本,同时也有助于降低引入错误的可能性。 1. ...

    JAVA的代码书写规范

    JAVA 代码书写规范 JAVA 代码书写规范是软件工程领域的一项重要组成部分,旨在提高程序的可靠性、可读性、可修改性、可维护性和一致性。以下是 JAVA 代码书写规范的详细介绍: 一、目的 JAVA 代码书写规范的...

    汇编语言代码书写规范

    《汇编语言代码书写规范》是一本指导程序员编写清晰、有序和可维护的汇编语言程序的指南。规范主要分为三个部分:文件结构、程序的版式和命名规则。 首先,我们来详细讨论文件结构。在汇编语言编程中,一个好的文件...

    java代码书写规范

    【Java代码书写规范】 在Java编程中,代码的书写规范是非常重要的,它有助于提高代码的可读性,便于团队协作和后期维护。以下是一些关键的命名规则和书写规范: 1. **命名规则**: - **通用规则**:所有命名应该...

    Java代码书写规范

    ### Java代码书写规范知识点解析 #### 一、符号命名规则 **1.1 通用规则** - **标准英文单词或缩写**: 在所有的命名中,都应当使用标准的英文单词或者标准的英文缩写,避免使用汉语拼音或者汉语拼音的缩写。例如...

    VHDL代码书写规范

    VHDL代码书写规范旨在提升代码的可读性、可修改性以及可重用性,同时优化代码综合和仿真结果。在硬件描述语言VHDL(Very high-speed IC Hardware Description Language)开发项目中,确保设计工程师能够使用规范化的...

    WS代码书写规范.doc

    《WS代码书写规范》文档详细阐述了在VB.NET编程中应遵循的一系列规范,旨在提高代码的可读性、可维护性和团队协作效率。以下是该规范的要点解析: 1. **文件结构** - 工作站代码使用VB.NET 2008进行开发,所有文件...

    Python代码书写规范与基本使⽤.pdf

    Python代码书写规范是编写清晰、可维护代码的基础。在Python社区中,遵循PEP 8编码规范是一个良好实践。此规范详细地描述了代码的排版、空格使用、缩进、注释和命名等多方面的标准。 首先,关于代码书写规范,在...

    python bug清除手册-代码书写规范与基本使用.pdf

    #### 一、代码书写规范 **1.1 等号两侧空格的使用** 在Python中,等号(`=`)用于赋值操作。根据PEP 8(Python Enhancement Proposal 8)—— Python官方的代码风格指南,建议在赋值操作符`=`的两边各添加一个空格...

    C++编程代码书写规范.zip

    在C++编程中,代码书写规范对于开发出高效、可读性强、易于维护的软件至关重要。这份名为"C++编程代码书写规范"的资料提供了一套详细的指导原则,旨在帮助开发者编写高质量的C++代码,并提供了150条具体的改善建议。...

Global site tag (gtag.js) - Google Analytics