「编程规范Java」编程规范如果编程工具提供将TAB

admin 2023-01-04 18:09:08 1207

今天给各位分享编程规范Java的知识，其中也会对编程规范如果编程工具提供将TAB进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！

本文目录一览：

1、北大青鸟java培训：学Java需要注意什么？
2、电脑培训分享Java编程开发规范及其技巧
3、零基础学习Java编程需要知道的十二个步骤!
4、java编码规范有哪些？
5、java的语言标识符规则是什么？
6、java编程规范！！！

北大青鸟java培训：学Java需要注意什么？

Java从入门到精通学习应该怎么做呢？做好哪些事情可以更快的入门Java编程？今天就让小编来帮你梳理一下~ Java编程语言是一种可以撰写跨平台应用软件的面向对象的程序设计语言。

Java编程技术具有卓越的通用性、高效性、平台移植性和安全性，广泛应用于个人PC、数据中心、游戏控制台、科学超级计算机、移动电话和互联网，同时拥有全球最大的开发者专业社群。

在全球云计算和移动互联网的产业环境下，Java更具备了显著优势和广阔前景。

No.1找一本好的书本教材好的教材，可以让你更快更好的进入Java的世界。

在校学生的话，你们的教材通常都是不错的也可以到职坐标的优才商城选择合适的教材。

No.2学好基本语法，弄清Java的特点学习Java，说白了，就是学习它的语法、功能、结构等。

然后按照它的语法编写代码。

Java语法是学习的根本。

开始学习时，可能有些难懂。

没关系，这很正常。

多看多问，多实践，慢慢的你就入门了。

No.3没有捷径，一定要多动手实践学习Java，和学数学一样，在学懂理论后，一定要实践。

学习Java不能搭便车。

有时候，语法和例子很简单，很容易看懂，但到自己动手写的时候，又是另一种感觉。

只有多动手编程，哪怕是简单的小程序，重复实现书上简单的例子，也是在积累和提高。

动手编码离不开编程工具的支持。

No.4学习编程规范，编程中坚持遵守俗话说，无规矩不成方圆。

编程是一个将思维逻辑变为代码，让计算机来执行的过程。

特别需要规范。

无论是变量、函数命名还是代码格式，都需要一致规范。

这样便于代码的阅读和修改。

代码的规范性，在代码质量中占据着重要的比重。

No.5给代码添加足够的注释说明代码注释的作用，毫不夸张的说，就像旅游景点的指示牌。

我们在编程时，对自己的想法十分清楚。

但一段时间之后呢，或者让别人来阅读代码呢。

如果注释丰富，读代码就大体可以用读注释来代替了。

注意，注释要对那些有一定难度的语句、过程方法或结构等的注释，非常浅显易懂的就不需要注释啦。

养成对难懂代码注释的习惯吧。

No.6多看别人的代码对同一种功能的实现，可以有很多种编码方式。

多读别人的代码，非常有利用开拓思路，提高编码的灵活性。

甚至经常可以从别人的代码中得到启发，产生灵感，创作出优秀的代码。

No.7代码尽量写的简单，易于理解代码的简单性、正确性是最重要的。

不要为了追求高效率而写出晦涩难懂的代码。

后续阅读和修改代码时，你会为晦涩的代码付出很多代价。

记住，尽量将代码写成初学Java就能读懂的，那么你的代码就十分的优美了。

No.8学习设计模式设计模式就是高手们总结的一些关于编程方法的总结，这对新手来说非常的有用。

学习设计模式，可以提高我们编程的灵活度以及设计的合理性。

不仅Java，其他编程语言，如C#、C++中，设计模式也在大行其道。

所以，你没有理由错过高手们总结的编程精华。

No.9喜欢它，并坚持走下去Java的学习，容易入门，却难以精通。

永远不要因为害怕困难，而减少你对它的兴趣。

每年都有很多人在学习Java，因为它很强大。

如果你能坚持下去，那么你也是强大的。

No.10选择一套体系完善的课程在完善的课程体系中学习非常重要，这有助于你掌握系统的Java编程知识和技能，而且好的课程会帮助你前期打好基础，后期有针对性地使你快速提升，这对Java新手来说十分有效。

比如云和数据的Java大数据企业直通班，不仅有国际名师在线指导，还有牛人大咖全程面授，“六位一体”、“X+12”双重教学模式，打造一流完善的课程体系，可以给你全方位因材施教的教学指导。

关于我们学校简介

回答于 2022-10-28

详情

该链接由问题回答方推荐

官方电话

在线客服

官方服务

官方网站

领学习资料

计算机培训

设计培训

编程培训

电脑培训分享Java编程开发规范及其技巧

在用Java进行开发前，一定要牢牢遵守Java的开发规范，只有这样你的Java开发之路才能更加顺畅。而掌握相应的Java开发技巧，则可以让你工作起来事半功倍。那在编写代码时有什么开发规范和技巧呢？电脑培训给你详细介绍一下吧。

1、代码编写规范：

代码编写遵守Java通用开发规范和必联代码开发规范；

每个类及方法都要有合理的注释，并且对注释要持续维护；

根据接口需求编写单元测试用例，再编写实现类使得单元测试通过，如此循环往复以使得所有的单元测试通过；

要求每个Java方法的代码行数不能超过100行；

代码编写按照功能划分，一个接口分为多个方法，每一个方法做什么事情，做到思路清晰；

接口设计尽量做到多兼容性，方便后期开发。

2、数据库设计及SQL规范

不使用MySQL数据库外键约束，通过应用程序逻辑实现关联约束；

适当建立索引，经常作为查询条件的字段、唯一性程度高、长度不是很长的、数量不宜太多，一般一个表的索引数目在5个以内；

表名长度不能超过30个字符，表名最好选择一个单词，能够准确清晰明了地表示实体含义，若必须多个单词则以下划线“_”分隔，单词所有字母均小写；

零基础学习Java编程需要知道的十二个步骤!

一、学习前的准备工作java语言一般用于大型的服务器程序开发，所有有必要了解如下内容：Unix开发环境Unix系统原理、Unix开发环境、Unix常用命令。熟练掌握Unix常用命令；熟练构建下的Java开发环境。二、Java语言基础的学习阶段学习任何一门语言都要打好基础，曾经学过高级程序语言（C，C++等）来说，java语言基础有自己的特点，但是基本规律都是相通的，如：算法基础、常用数据结构、企业编程规范。掌握常见的数据结构和实用算法；培养良好的企业级编程习惯。

三、面向对象语言的共性Java面向对象面向对象特性：封装、继承、多态等。掌握面向对象的基本原则以及在编程实践中的意义；掌握Java面向对象编程基本实现原理。四、JDK核心API语言核心包、异常处理、常用工具包、集合框架熟练掌握JDK核心API编程技术；理解API设计原则；具备熟练的阅读API文档的能力；JavaSE核心异常处理、多线程基础、IO系统、网络编程、Swing组件、JVM性能调优（JVM内存结构剖析、GC分析及调优、JVM内存参数优化）、Java泛型、JDK新特性。熟练掌握JavaSE核心内容，特别是IO和多线程；初步具备面向对象设计和编程的能力；掌握基本的JVM优化策略。XMLXML语法、XML解析（SAX、DOM）、Dom4j组件、Digester组件。熟练掌握XML语法规则；理解DOM模型；熟悉Java对XML的各种解析方式。五、SQL语言SQL语句基础和提高、SQL语句调优熟练的掌握SQL语句；掌握一定的数据库查询技巧及SQL语句优化技巧。Oracle数据库开发Oracle体系结构及系统管理、Oracle数据库高级编程、数据库设计基础。掌握Oracle体系结构及核心编程技术。六、连接数据库：JDBCJDBC核心API（Connection、Statement、ResultSet）、JDBC优化技术（缓存技术、批处理技术、连接池技术）理解JDBC作为规范的设计原则；熟练掌握JDBCAPI；具备使用JDBC对数据库进行高效访问的能力。七、软件工程基础软件过程和软件活动需求设计、概要设计、详细设计基本原则和文档规范；配置管理的基本概念和必要性；CVS基本操作；Ant简介理解软件过程的普遍概念和基本的软件活动；理解迭代的意义；掌握Ant、CVS等常用配置管理及部署工具。八、OOAD及设计模式面向对象基本设计原则、工厂模式、策略模式、适配器模式、代理模式等、门面模式理解面向对象设计的一般原则；理解重用的意义；掌握常见的设计模式。九、HTML/CSSHTML基本文档结构、掌握CSS基础语法、关于HTML文档块、链接、列表、表格、表单等掌握十、Ajax基础、XHR对象、Ajax设计模式、JSON技术掌握Ajax的基本通信原理；掌握基于XML和JSON的Ajax数据规则。十一、JavaScript框架JQuery、JQuery插件、DWR掌握JQuery核心API；了解JQuery基本设计原则；了解多种JQuery插件；掌握DWR的基本原理及应用技巧。十二、ssh三大框架的学习这是企业实际应用的框架模型：1，Struts2.1.6Struts2核心控制流程、Ognl、Action、Interceptor、,Result、FreeMarker、Struts2标记库、Struts2扩展、Struts2应用技巧（输入验证、消息国际化、文件上传和下载、防止重复提交等）。熟练掌握Struts2核心要件，特别是Interceptor和Result；掌握基于模板技术的Struts2UI组件；掌握基于Ognl的数据共享方式、掌握Struts2各种定制及扩展方式；熟练掌握基于Struts2的Web开发技巧。2，Hibernate3.2.1ORM概念、Hibernate核心API、Hibernate实体映射技术、Hibernate关系映射技巧、HQL查询、OSCache及Hibernate缓存技术。重点掌握Hibernate多种关联映射技巧及其实用背景，做到在合适的时候使用合适的关联方式；掌握多种Hibernate查询技巧及优化技术。3，Spring2.5SpringIoc基础、Ioc注入技巧、对象高级装配（自动装配、模板装配、组件扫描特性、FactoryBean、对象生命周期）、SpringAOP原理、AspectJ、SpringJDBC支持、Spring事务及安全管理；Spring整合Hibernate、Spring整合Struts、SpringMVC简介。深入理解Ioc和AOP的基本原理和实现方式；熟练掌握SpringIoc及AOP实现方式；熟练掌握Spring事务管理；熟练掌握Spring与其他组件的整合技术。

java编码规范有哪些？

尽量使用完整的英文描述符，采用适用于相关领域的术语，采用大小写混合使名字可读。

JAVA代码规范：

(1)类名首字母应该大写。字段、方法以及对象（句柄）的首字母应小写。对于所有标识符，其中包含的所有单词都应紧靠在一起，而且大写中间单词的首字母。例如：

ThisIsAClassName

thisIsMethodOrFieldName

若在定义中出现了常数初始化字符，则大写static final基本类型标识符中的所有字母。这样便可标志出它们属于编译期的常数。Java包（Package）属于一种特殊情况：它们全都是小写字母，即便中间的单词亦是如此。对于域名扩展名称，如com，org，net或者edu等，全部都应小写（这也是Java1.1和Java1.2的区别之一）。

(2)为了常规用途而创建一个类时，请采取"经典形式"，并包含对下述元素的定义：equals()

hashCode()

toString()

clone()（implement Cloneable）

implement Serializable

(3)对于自己创建的每一个类，都考虑置入一个main()，其中包含了用于测试那个类的代码。为使用一个项目中的类，我们没必要删除测试代码。若进行了任何形式的改动，可方便地返回测试。这些代码也可作为如何使用类的一个示例使用。

(4)应将方法设计成简要的、功能性单元，用它描述和实现一个不连续的类接口部分。理想情况下，方法应简明扼要。若长度很大，可考虑通过某种方式将其分割成较短的几个方法。这样做也便于类内代码的重复使用（有些时候，方法必须非常大，但它们仍应只做同样的一件事情）。

(5)设计一个类时，请设身处地为客户程序员考虑一下（类的使用方法应该是非常明确的）。然后，再设身处地为管理代码的人考虑一下（预计有可能进行哪些形式的修改，想想用什么方法可把它们变得更简单）。

(6)使类尽可能短小精悍，而且只解决一个特定的问题。下面是对类设计的一些建议：

一个复杂的开关语句：考虑采用"多形"机制

数量众多的方法涉及到类型差别极大的操作：考虑用几个类来分别实现

许多成员变量在特征上有很大的差别：考虑使用几个类

(7)让一切东西都尽可能地"私有"-private。可使库的某一部分"公共化"（一个方法、类或者一个字段等等），就永远不能把它拿出。若强行拿出，就可能破坏其他人现有的代码，使他们不得不重新编写和设计。若只公布自己必须公布的，就可放心大胆地改变其他任何东西。在多线程环境中，隐私是特别重要的一个因素-只有private字段才能在非同步使用的情况下受到保护。

(8)谨惕"巨大对象综合症。对一些习惯于顺序编程思维、且初涉OOP领域的新手，往往喜欢先写一个顺序执行的程序，再把它嵌入一个或两个巨大的对象里。根据编程原理，对象表达的应该是应用程序的概念。

java的语言标识符规则是什么？

Java标识符的命名规则：\x0d\x0a1）标识符由字母、数字、下划线“_”、美元符号“$”或者人民币符号“￥”组成，并且首字母不能是数字。\x0d\x0a2）不能把关键字和保留字作为标识符。\x0d\x0a3）标识符没有长度限制。\x0d\x0a4）标识符对大小写敏感。Java编程规范：1）类名和接口名：首字母大写，其余字母小写。如SamDoc\x0d\x0a2）方法名和变量名：首字母小写，其余的字母大写。\x0d\x0a如bothEyesOfDoll。\x0d\x0a3）包名：字母全部小写。如，com.abc.dollapp。\x0d\x0a4）常量名：采用大写形式，单词之间以下划线“_”隔开。

java编程规范！！！

名称 Java语言编码规范(Java Code Conventions)

　简介本文档讲述了Java语言的编码规范，较之陈世忠先生《c++编码规范》的浩繁详尽，此文当属短小精悍了。而其中所列之各项条款，从编码风格，到注意事项，不单只Java，对于其他语言，也都很有借鉴意义。因为简短，所以易记，大家不妨将此作为handbook，常备案头，逐一对验。

1 介绍

1.1 为什么要有编码规范

2 文件名

2.1 文件后缀

2.2 常用文件名

3 文件组织

3.1 Java源文件

3.1.1 开头注释

3.1.2 包和引入语句

3.1.3 类和接口声明

4 缩进排版

4.1 行长度

4.2 换行

5 注释

5.1 实现注释的格式

5.1.1 块注释

5.1.2 单行注释

5.1.3 尾端注释

5.1.4 行末注释

5.2 文挡注释

6 声明

6.1 每行声明变量的数量

6.2 初始化

6.3 布局

6.4 类和接口的声明

7 语句

7.1 简单语句

7.2 复合语句

7.3 返回语句

7.4 if，if-else，if else-if else语句

7.5 for语句

7.6 while语句

7.7 do-while语句

7.8 switch语句

7.9 try-catch语句

8 空白

8.1 空行

8.2 空格

9 命名规范

10 编程惯例

10.1 提供对实例以及类变量的访问控制

10.2 引用类变量和类方法

10.3 常量

10.4 变量赋值

10.5 其它惯例

10.5.1 圆括号

10.5.2 返回值

10.5.3 条件运算符"?"前的表达式"?"前的表达式

10.5.4 特殊注释

11 代码范例

11.1 Java源文件范例

1 介绍(Introduction)

1.1 为什么要有编码规范(Why Have Code Conventions)

编码规范对于程序员而言尤为重要，有以下几个原因：

- 一个软件的生命周期中，80%的花费在于维护

- 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护

- 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码

- 如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品

为了执行规范，每个软件开发人员必须一致遵守编码规范。每个人。

本文档反映的是Sun MicroSystems公司，Java语言规范中的编码标准部分。主要贡献者包括：Peter King，Patrick Naughton，Mike DeMoney，Jonni Kanerva，Kathy Walrath以及Scott Hommel。

本文档现由Scott Hommel维护，有关评论意见请发至shommel@eng.sun.com

2 文件名(File Names)

这部分列出了常用的文件名及其后缀。

2.1 文件后缀(File Suffixes)

Java程序使用下列文件后缀：

文件类别文件后缀

Java源文件 .java

Java字节码文件 .class

2.2 常用文件名(Common File Names)

常用的文件名包括：

文件名用途

GNUmakefile makefiles的首选文件名。我们采用gnumake来创建（build）软件。

README 概述特定目录下所含内容的文件的首选文件名

3 文件组织(File Organization)

一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过2000行的程序难以阅读，应该尽量避免。"Java源文件范例"提供了一个布局合理的Java程序范例。

3.1 Java源文件(Java Source Files)

每个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联，可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。

Java源文件还遵循以下规则：

- 开头注释（参见"开头注释"）

- 包和引入语句（参见"包和引入语句"）

- 类和接口声明（参见"类和接口声明"）

3.1.1 开头注释(Beginning Comments)

* Classname

* Version information

* Date

* Copyright notice

3.1.2 包和引入语句(Package and Import Statements)

在多数Java源文件中，第一个非注释行是包语句。在它之后可以跟引入语句。例如：

package java.awt;

import java.awt.peer.CanvasPeer;

3.1.3 类和接口声明(Class and Interface Declarations)

下表描述了类和接口声明的各个部分以及它们出现的先后次序。参见"Java源文件范例"中一个包含注释的例子。

类/接口声明的各部分注解

1 类/接口文档注释(/**……*/) 该注释中所需包含的信息，参见"文档注释"

2 类或接口的声明

3 类/接口实现的注释(/*……*/)如果有必要的话该注释应包含任何有关整个类或接口的信息，而这些信息又不适合作为类/接口文档注释。

4 类的(静态)变量首先是类的公共变量，随后是保护变量，再后是包一级别的变量(没有访问修饰符，access modifier)，最后是私有变量。

5 实例变量首先是公共级别的，随后是保护级别的，再后是包一级别的(没有访问修饰符)，最后是私有级别的。

6 构造器

7 方法这些方法应该按功能，而非作用域或访问权限，分组。例如，一个私有的类方法可以置于两个公有的实例方法之间。其目的是为了更便于阅读和理解代码。

4 缩进排版(Indentation)

4个空格常被作为缩进排版的一个单位。缩进的确切解释并未详细指定(空格 vs. 制表符)。一个制表符等于8个空格(而非4个)。

4.1 行长度(Line Length)

尽量避免一行的长度超过80个字符，因为很多终端和工具不能很好处理之。

注意：用于文档中的例子应该使用更短的行长，长度一般不超过70个字符。

4.2 换行(Wrapping Lines)

当一个表达式无法容纳在一行内时，可以依据如下一般规则断开之：

- 在一个逗号后面断开

- 在一个操作符前面断开

- 宁可选择较高级别(higher-level)的断开，而非较低级别(lower-level)的断开

- 新的一行应该与上一行同一级别表达式的开头处对齐

- 如果以上规则导致你的代码混乱或者使你的代码都堆挤在右边，那就代之以缩进8个空格。

以下是断开方法调用的一些例子：

someMethod(longExpression1, longExpression2, longExpression3,

longExpression4, longExpression5);

var = someMethod1(longExpression1,

someMethod2(longExpression2,

longExpression3));

以下是两个断开算术表达式的例子。前者更好，因为断开处位于括号表达式的外边，这是个较高级别的断开。

longName1 = longName2 * (longName3 + longName4 - longName5)

+ 4 * longname6; //PREFFER

longName1 = longName2 * (longName3 + longName4

- longName5) + 4 * longname6; //AVOID

以下是两个缩进方法声明的例子。前者是常规情形。后者若使用常规的缩进方式将会使第二行和第三行移得很靠右，所以代之以缩进8个空格

//CONVENTIONAL INDENTATION

someMethod(int anArg, Object anotherArg, String yetAnotherArg,

Object andStillAnother) {

...

}

//INDENT 8 SPACES TO AVOID VERY DEEP INDENTS

private static synchronized horkingLongMethodName(int anArg,

Object anotherArg, String yetAnotherArg,

Object andStillAnother) {

...

}

if语句的换行通常使用8个空格的规则，因为常规缩进(4个空格)会使语句体看起来比较费劲。比如：

//DON’T USE THIS INDENTATION

if ((condition1 condition2)

|| (condition3 condition4)

||!(condition5 condition6)) { //BAD WRAPS

doSomethingAboutIt(); //MAKE THIS LINE EASY TO MISS

}

//USE THIS INDENTATION INSTEAD

if ((condition1 condition2)

|| (condition3 condition4)

||!(condition5 condition6)) {

doSomethingAboutIt();

}

//OR USE THIS

if ((condition1 condition2) || (condition3 condition4)

||!(condition5 condition6)) {

doSomethingAboutIt();

}

这里有三种可行的方法用于处理三元运算表达式：

alpha = (aLongBooleanExpression) ? beta : gamma;

alpha = (aLongBooleanExpression) ? beta

: gamma;

alpha = (aLongBooleanExpression)

? beta

: gamma;

5 注释(Comments)

Java程序有两类注释：实现注释(implementation comments)和文档注释(document comments)。实现注释是那些在C++中见过的，使用/*...*/和//界定的注释。文档注释(被称为"doc comments")是Java独有的，并由/**...*/界定。文档注释可以通过javadoc工具转换成HTML文件。

实现注释用以注释代码或者实现细节。文档注释从实现自由(implementation-free)的角度描述代码的规范。它可以被那些手头没有源码的开发人员读懂。

注释应被用来给出代码的总括，并提供代码自身没有提供的附加信息。注释应该仅包含与阅读和理解程序有关的信息。例如，相应的包如何被建立或位于哪个目录下之类的信息不应包括在注释中。

在注释里，对设计决策中重要的或者不是显而易见的地方进行说明是可以的，但应避免提供代码中己清晰表达出来的重复信息。多余的的注释很容易过时。通常应避免那些代码更新就可能过时的注释。

注意：频繁的注释有时反映出代码的低质量。当你觉得被迫要加注释的时候，考虑一下重写代码使其更清晰。

注释不应写在用星号或其他字符画出来的大框里。注释不应包括诸如制表符和回退符之类的特殊字符。

5.1 实现注释的格式(Implementation Comment Formats)

程序可以有4种实现注释的风格：块(block)、单行(single-line)、尾端(trailing)和行末(end-of-line)。

5.1.1 块注释(Block Comments)

块注释通常用于提供对文件，方法，数据结构和算法的描述。块注释被置于每个文件的开始处以及每个方法之前。它们也可以被用于其他地方，比如方法内部。在功能和方法内部的块注释应该和它们所描述的代码具有一样的缩进格式。

块注释之首应该有一个空行，用于把块注释和代码分割开来，比如：

* Here is a block comment.

块注释可以以/*-开头，这样indent(1)就可以将之识别为一个代码块的开始，而不会重排它。

/*-

* Here is a block comment with some very special

* formatting that I want indent(1) to ignore.

* one

* two

* three

注意：如果你不使用indent(1)，就不必在代码中使用/*-，或为他人可能对你的代码运行indent(1)作让步。

参见"文档注释"

5.1.2 单行注释(Single-Line Comments)

短注释可以显示在一行内，并与其后的代码具有一样的缩进层级。如果一个注释不能在一行内写完，就该采用块注释(参见"块注释")。单行注释之前应该有一个空行。以下是一个Java代码中单行注释的例子：

if (condition) {

/* Handle the condition. */

...

}

5.1.3 尾端注释(Trailing Comments)

极短的注释可以与它们所要描述的代码位于同一行，但是应该有足够的空白来分开代码和注释。若有多个短注释出现于大段代码中，它们应该具有相同的缩进。

以下是一个Java代码中尾端注释的例子：

if (a == 2) {

return TRUE; /* special case */

} else {

return isPrime(a); /* works only for odd a */

}

5.1.4 行末注释(End-Of-Line Comments)

注释界定符"//"，可以注释掉整行或者一行中的一部分。它一般不用于连续多行的注释文本；然而，它可以用来注释掉连续多行的代码段。以下是所有三种风格的例子：

if (foo 1) {

// Do a double-flip.

...

}

else {

return false; // Explain why here.

}

//if (bar 1) {

// // Do a triple-flip.

// ...

//}

//else {

// return false;

//}

5.2 文档注释(Documentation Comments)

注意：此处描述的注释格式之范例，参见"Java源文件范例"

若想了解更多，参见"How to Write Doc Comments for Javadoc"，其中包含了有关文档注释标记的信息(@return, @param, @see)：

若想了解更多有关文档注释和javadoc的详细资料，参见javadoc的主页：

文档注释描述Java的类、接口、构造器，方法，以及字段(field)。每个文档注释都会被置于注释定界符/**...*/之中，一个注释对应一个类、接口或成员。该注释应位于声明之前：

/**

* The Example class provides ...

public class Example { ...

注意顶层(top-level)的类和接口是不缩进的，而其成员是缩进的。描述类和接口的文档注释的第一行(/**)不需缩进；随后的文档注释每行都缩进1格(使星号纵向对齐)。成员，包括构造函数在内，其文档注释的第一行缩进4格，随后每行都缩进5格。

若你想给出有关类、接口、变量或方法的信息，而这些信息又不适合写在文档中，则可使用实现块注释(见5.1.1)或紧跟在声明后面的单行注释(见5.1.2)。例如，有关一个类实现的细节，应放入紧跟在类声明后面的实现块注释中，而不是放在文档注释中。

文档注释不能放在一个方法或构造器的定义块中，因为Java会将位于文档注释之后的第一个声明与其相关联。

6 声明(Declarations)

6.1 每行声明变量的数量(Number Per Line)

推荐一行一个声明，因为这样以利于写注释。亦即，

int level; // indentation level

int size; // size of table

要优于，

int level, size;

不要将不同类型变量的声明放在同一行，例如：

int foo, fooarray[]; //WRONG!

注意：上面的例子中，在类型和标识符之间放了一个空格，另一种被允许的替代方式是使用制表符：

int level; // indentation level

int size; // size of table

Object currentEntry; // currently selected table entry

6.2 初始化(Initialization)

尽量在声明局部变量的同时初始化。唯一不这么做的理由是变量的初始值依赖于某些先前发生的计算。

6.3 布局(Placement)

只在代码块的开始处声明变量。（一个块是指任何被包含在大括号"{"和"}"中间的代码。）不要在首次用到该变量时才声明之。这会把注意力不集中的程序员搞糊涂，同时会妨碍代码在该作用域内的可移植性。

void myMethod() {

int int1 = 0; // beginning of method block

if (condition) {

int int2 = 0; // beginning of "if" block

...

}

该规则的一个例外是for循环的索引变量

for (int i = 0; i maxLoops; i++) { ... }

避免声明的局部变量覆盖上一级声明的变量。例如，不要在内部代码块中声明相同的变量名：

int count;

...

myMethod() {

if (condition) {

int count = 0; // AVOID!

...

}

...

}

6.4 类和接口的声明(Class and Interface Declarations)

当编写类和接口是，应该遵守以下格式规则：

- 在方法名与其参数列表之前的左括号"("间不要有空格

- 左大括号"{"位于声明语句同行的末尾

- 右大括号"}"另起一行，与相应的声明语句对齐，除非是一个空语句，"}"应紧跟在"{"之后

class Sample extends Object {

int ivar1;

int ivar2;

Sample(int i, int j) {

ivar1 = i;

ivar2 = j;

}

int emptyMethod() {}

...

}

- 方法与方法之间以空行分隔

7 语句(Statements)

7.1 简单语句(Simple Statements)

每行至多包含一条语句，例如：

argv++; // Correct

argc--; // Correct

argv++; argc--; // AVOID!

7.2 复合语句(Compound Statements)

复合语句是包含在大括号中的语句序列，形如"{ 语句 }"。例如下面各段。

- 被括其中的语句应该较之复合语句缩进一个层次

- 左大括号"{"应位于复合语句起始行的行尾；右大括号"}"应另起一行并与复合语句首行对齐。

- 大括号可以被用于所有语句，包括单个语句，只要这些语句是诸如if-else或for控制结构的一部分。这样便于添加语句而无需担心由于忘了加括号而引入bug。

7.3 返回语句(return Statements)

一个带返回值的return语句不使用小括号"()"，除非它们以某种方式使返回值更为显见。例如：

return;

return myDisk.size();

return (size ? size : defaultSize);

7.4 if，if-else，if else-if else语句(if, if-else, if else-if else Statements)

if-else语句应该具有如下格式：

if (condition) {

statements;

}

if (condition) {

statements;

} else {

statements;

}

if (condition) {

statements;

} else if (condition) {

statements;

} else{

statements;

}

注意：if语句总是用"{"和"}"括起来，避免使用如下容易引起错误的格式：

if (condition) //AVOID! THIS OMITS THE BRACES {}!

statement;

7.5 for语句(for Statements)

一个for语句应该具有如下格式：

for (initialization; condition; update) {

statements;

}

一个空的for语句(所有工作都在初始化，条件判断，更新子句中完成）应该具有如下格式：

for (initialization; condition; update);

当在for语句的初始化或更新子句中使用逗号时，避免因使用三个以上变量，而导致复杂度提高。若需要，可以在for循环之前(为初始化子句)或for循环末尾(为更新子句)使用单独的语句。

7.6 while语句(while Statements)

一个while语句应该具有如下格式

while (condition) {

statements;

}

一个空的while语句应该具有如下格式：

while (condition);

7.7 do-while语句(do-while Statements)

一个do-while语句应该具有如下格式：

do {

statements;

} while (condition);

7.8 switch语句(switch Statements)

一个switch语句应该具有如下格式：

switch (condition) {

case ABC:

statements;

/* falls through */

case DEF:

statements;

break;

case XYZ:

statements;

break;

default:

statements;

break;

}

每当一个case顺着往下执行时(因为没有break语句)，通常应在break语句的位置添加注释。上面的示例代码中就包含注释/* falls through */。

7.9 try-catch语句(try-catch Statements)

一个try-catch语句应该具有如下格式：

try {

statements;

} catch (ExceptionClass e) {

statements;

}

一个try-catch语句后面也可能跟着一个finally语句，不论try代码块是否顺利执行完，它都会被执行。

try {

statements;

} catch (ExceptionClass e) {

statements;

} finally {

statements;

}

8 空白(White Space)

8.1 空行(Blank Lines)

空行将逻辑相关的代码段分隔开，以提高可读性。

下列情况应该总是使用两个空行：

- 一个源文件的两个片段(section)之间

- 类声明和接口声明之间

下列情况应该总是使用一个空行：

- 两个方法之间

- 方法内的局部变量和方法的第一条语句之间

- 块注释（参见"5.1.1"）或单行注释（参见"5.1.2"）之前

- 一个方法内的两个逻辑段之间，用以提高可读性

8.2 空格(Blank Spaces)

下列情况应该使用空格：

- 一个紧跟着括号的关键字应该被空格分开，例如：

while (true) {

...

}

注意：空格不应该置于方法名与其左括号之间。这将有助于区分关键字和方法调用。

- 空白应该位于参数列表中逗号的后面

- 所有的二元运算符，除了"."，应该使用空格将之与操作数分开。一元操作符和操作数之间不因该加空格，比如：负号("-")、自增("++")和自减("--")。例如：

a += c + d;

a = (a + b) / (c * d);

while (d++ = s++) {

n++;

}

printSize("size is " + foo + "\n");

- for语句中的表达式应该被空格分开，例如：

for (expr1; expr2; expr3)

- 强制转型后应该跟一个空格，例如：

myMethod((byte) aNum, (Object) x);

myMethod((int) (cp + 5), ((int) (i + 3)) + 1);

9 命名规范(Naming Conventions)

命名规范使程序更易读，从而更易于理解。它们也可以提供一些有关标识符功能的信息，以助于理解代码，例如，不论它是一个常量，包，还是类。

标识符类型命名规则例子

包(Packages) 一个唯一包名的前缀总是全部小写的ASCII字母并且是一个顶级域名，通常是com，edu，gov，mil，net，org，或1981年ISO 3166标准所指定的标识国家的英文双字符代码。包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门(department)，项目(project)，机器(machine)，或注册名(login names)。 com.sun.eng

com.apple.quicktime.v2

edu.cmu.cs.bovik.cheese

类(Classes) 命名规则：类名是个一名词，采用大小写混合的方式，每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词，避免缩写词(除非该缩写词被更广泛使用，像URL，HTML) class Raster;

class ImageSprite;

接口(Interfaces) 命名规则：大小写规则与类名相似 interface RasterDelegate;

interface Storing;

方法(Methods) 方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。 run();

runFast();

getBackground();

变量(Variables) 除了变量名外，所有实例，包括类，类常量，均采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。变量名不应以下划线或美元符号开头，尽管这在语法上是允许的。

变量名应简短且富于描述。变量名的选用应该易于记忆，即，能够指出其用途。尽量避免单个字符的变量名，除非是一次性的临时变量。临时变量通常被取名为i，j，k，m和n，它们一般用于整型；c，d，e，它们一般用于字符型。 char c;

int i;

float myWidth;

实例变量(Instance Variables) 大小写规则和变量名相似，除了前面需要一个下划线 int _employeeId;

String _name;

Customer _customer;

常量(Constants) 类常量和ANSI常量的声明，应该全部大写，单词间用下划线隔开。(尽量避免ANSI常量，容易引起错误) static final int MIN_WIDTH = 4;

static final int MAX_WIDTH = 999;

static final int GET_THE_CPU = 1;

10 编程惯例(Programming Practices)

10.1 提供对实例以及类变量的访问控制(Providing Access to Instance and Class Variables)

若没有足够理由，不要把实例或类变量声明为公有。通常，实例变量无需显式的设置(set)和获取(gotten)，通常这作为方法调用的边缘效应 (side effect)而产生。

一个具有公有实例变量的恰当例子，是类仅作为数据结构，没有行为。亦即，若你要使用一个结构(struct)而非一个类(如果java支持结构的话)，那么把类的实例变量声明为公有是合适的。

关于编程规范Java和编程规范如果编程工具提供将TAB的介绍到此就结束了，不知道你从中找到你需要的信息了吗？如果你还想了解更多这方面的信息，记得收藏关注本站。

标签：编程规范Java