Java代码编写规范

一、说在前面:

建议参考:https://blog.csdn.net/weixin_30550271/article/details/99085561

二、前言

1、“代码规范”可以分成两个部分。

(1)代码风格规范。主要是文字上的规定,看似表面文章,实际上非常重要。

(2)代码设计规范。牵涉到程序设计、模块之间的关系、设计模式等方方面面,这里有不少与具体程序设计语言息息相关的内容(如C/C++/Java/C#),但是也有通用的原则。

这里主要讨论通用的原则。

2、代码风格的原则是:简明,易读,无二义性。

三、几个建议

1、代码规范-缩进:用好TAB键,在VS2005和其他的一些编辑工具中都可以定义Tab键扩展成为几个空格键。用 Tab键的理由是Tab键在不同的情况下会显示不同的长度。4个空格的距离从可读性来说正好。

2、代码规范-行宽:建议每行不超过100个字符

3、代码规范-括号:在复杂的条件表达式中,用括号清楚地表示逻辑优先级。

4、代码规范-断行与空白的{ }行:每个“{”和“}”都独占一行。可以清楚的知道括号的匹配关系:

if ( condition) 
{
    DoSomething(); 
}
else 
{
    DoSomethingElse();
}

5、代码规范-分行:不要把多行语句放在一行上。

6、代码规范-命名:大家都知道用单个字母给有复杂语义的实体命名是不好的,目前最通用的,也是经过了实践检验的方法叫“匈牙利命名法”

例如:

  fFileExist,表明是一个bool值,表示文件是否存在;

  szPath,表明是一个以0结束的字符串,表示一个路径。

总结:以两条规则为基础:

(1)标识符的名字以一个或者多个小写字母开头,用这些字母来指定数据类型。

(2)在标识符内,前缀以后就是一个或者多个第一个字母大写的单词,这些单词清楚地指出了源代码内那个对象的用途。比如,m_szStudentName表示一个学生名字的类成员变量,数据类型是字符串型。

7、代码规范-下划线问题:下划线用来分隔变量名字中的作用域标注和变量的语义,如:一个类型的成员变量通常用m_来表示。

8、 代码规范-大小写问题:

(1)由多个单词组成的变量名,如果全部都是小写,很不易读,一个简单的解决方案就是用大小写区分它们。

(2)Pascal——所有单词的第一个字母都大写;

(3)Camel——第一个单词全部小写,随后单词随Pascal格式,这种方式也叫lowerCamel。

(4)一个通用的做法是:所有的类型/类/函数名都用Pascal形式,所有的变量都用Camel形式。

(5)类/类型/变量:名词或组合名词,如Member、ProductInfo等。

(6)函数则用动词或动宾组合词来表示,如get/set; RenderPage()。

 9、代码规范-注释:

(1)注释也要随着程序的修改而不断更新,一个误导的(Misleading)注释往往比没有注释更糟糕。

(2)另外,注释(包括所有源代码)应只用ASCII字符,不要用中文或其他特殊字符,它们会极大地影响程序的可移植性。

(3)在现代编程环境中,程序编辑器可以设置各种好看的字体,可以使用不同的显示风格来表示程序的不同部分。

(4)注意: 有些程序设计语言的教科书对于基本的语法有详细的注释, 那是为了教学的目的, 不宜在正式项目中也这么做。

(5)复杂的注释应该放在函数头,很多函数头的注释都是解释参数的类型等的,如果程序正文已经能够说明参数的类型in/out等,就不要重复!

(6)不要注释程序是怎么工作的(How),你的程序本身就应该能说明这一问题。

原文地址:https://www.cnblogs.com/20183544-wangzhengshuai/p/12536513.html