Java的基本格式

基本格式：修饰符 class 类名（程序代码）

站在用户的角度思考问题，与客户深入沟通，找到碾子山网站设计与碾子山网站推广的解决方案，凭借多年的经验，让设计与互联网技术结合，创造个性化、用户体验好的作品，建站类型包括：成都网站设计、成都做网站、企业官网、英文网站、手机端网站、网站推广、申请域名、网络空间、企业邮箱。业务覆盖碾子山地区。

意义：Java中的程序代码都必须放在一个类中，对于类初学者可以简单地把它理解为一个java程序；类需要使用class作为关键字定义；而在class的前面可以有一些修饰符。

扩展资料

编写java时，特别需要注意的几个书写格式常见的错误：

1.java中的程序代码中功能执行语句的最后都必须用（;）结束。

这里需要注意的是，在程序中不要将英文的分号（;）误写成中文的分号（；） ，如果写成了中文的分号，编译器会报告“Invalid character”（无效字符）这样的错误信息。

2.Java语言是严格区分大小写的。在定义类时，不能将class写成Class，否则编译会报错。程序中定义一个computer的同时，还可以定义一个Computer，computer和Computer是两个全完不同的符号，在使用的时候需要注意。

3. 在编写java代码的时候为了便于阅读，通常会使用一种良好的格式进行排版，但这并不是必须的，我们也可以在两个单词或者符号之间任意换行。

参考资料：百度百科-java

java软件开发的代码规范

1、组织与风格

(1).关键词和操作符之间加适当的空格。

(2).相对独立的程序块与块之间加空行

(3).较长的语句、表达式等要分成多行书写。

(4).划分出的新行要进行适应的缩进，使排版整齐，语句可读。

(5).长表达式要在低优先级操作符处划分新行，操作符放在新行之首。

(6).循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分。

(7).若函数或过程中的参数较长，则要进行适当的划分。

(8).不允许把多个短语句写在一行中，即一行只写一条语句。

(9).函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格。

注：如果大家有兴趣可以到安安DIY创作室博客，有相关说明性的文章和解释。

2、注解

Java 的语法与 C++ 及为相似，那么，你知道 Java 的注释有几种吗？是两种？

// 注释一行

/* ...... */ 注释若干行

不完全对，除了以上两种之外，还有第三种，文档注释：

/** ...... */ 注释若干行，并写入 javadoc 文档

注释要简单明了。

String userName = null; //用户名

边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。

在必要的地方注释，注释量要适中。注释的内容要清楚、明了，含义准确，防止注释二义性。

保持注释与其描述的代码相邻，即注释的就近原则。

对代码的注释应放在其上方相邻位置，不可放在下面。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释应放在此域的右方；

同一结构中不同域的注释要对齐。

变量、常量的注释应放在其上方相邻位置或右方。

全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。

在每个源文件的头部要有必要的注释信息，包括：文件名；版本号；作者；生成日期；模块功能描述（如功能、主要算法、内部各部分之间的关系、该文件与其它文件关系等）；主要函数或过程清单及本文件历史修改记录等。

/**

* Copy Right Information : Neusoft IIT

* Project : eTrain

* JDK version used : jdk1.3.1

* Comments : config path

* Version : 1.01

* Modification history :2003.5.1

* Sr Date Modified By Why What is modified

* 1. 2003.5.2 Kevin Gao new

**/

在每个函数或过程的前面要有必要的注释信息，包括：函数或过程名称；功能描述；输入、输出及返回值说明；调用关系及被调用关系说明等

/**

* Description :checkout 提款

* @param Hashtable cart info

* @param OrderBean order info

* @return String

*/

public String checkout(Hashtable htCart,

OrderBean orderBean)

throws Exception{

}

javadoc注释标签语法

@author 对类的说明 标明开发该类模块的作者

@version 对类的说明 标明该类模块的版本

@see 对类、属性、方法的说明 参考转向，也就是相关主题

@param 对方法的说明 对方法中某参数的说明

@return 对方法的说明 对方法返回值的说明

@exception 对方法的说明 对方法可能抛出的异常进行说明

3、命名规范

定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。（这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性）较短的单词可通过去掉元音形成缩写；要不然最后自己写的代码自己都看不懂了，那可不行。

较长的单词可取单词的头几发符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级。

使用匈牙利表示法

Package 的命名

Package 的名字应该都是由一个小写单词组成。

package com.neu.util

Class 的命名

Class 的名字必须由大写字母开头而其他字母都小写的单词组成,对于所有标识符，其中包含的所有单词都应紧靠在一起，而且大写中间单词的首字母。

public class ThisAClassName{}

Class 变量的命名

变量的名字必须用一个小写字母开头。后面的单词用大写字母开头

userName , thisAClassMethod

Static Final 变量的命名

static Final 变量的名字应该都大写，并且指出完整含义。

/**

*DBConfig PATH

**/

public static final String

DB_CONFIG_FILE_PATH =com.neu.etrain.dbconfig;

参数的命名

参数的名字必须和变量的命名规范一致。

数组的命名

数组应该总是用下面的方式来命名：

byte[] buffer;

而不是：

byte buffer[];

方法的参数

使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字：

SetCounter(int size){

this.size = size;

}

4、文件样式

所有的 Java(*.java) 文件都必须遵守如下的样式规则：

版权信息

版权信息必须在 java 文件的开头，比如：

/*

* Copyright ? 2000 Shanghai XXX Co. Ltd.

* All right reserved.

*/

其他不需要出现在 javadoc 的信息也可以包含在这里。

Package/Imports

package 行要在 import 行之前，import 中标准的包名要在本地的包名之前，而且按照字母

顺序排列。如果 import 行中包含了同一个包中的不同子目录，则应该用 * 来处理。

package hotlava.net.stats;

import java io.*;

import java.util.Observable;

import hotlava.util.Application;

这里 java。io.* 使用来代替InputStream and OutputStream 的。

Class

接下来的是类的注释，一般是用来解释类的。

/**

* A class representing a set of packet and byte counters

* It is observable to allow it to be watched, but only

* reports changes when the current set is complete

*/

接下来是类定义，包含了在不同的行的 extends 和 implements

public class CounterSet

extends Observable

implements Cloneable

Class Fields

接下来是类的成员变量：

/**

* Packet counters

*/

protected int[] packets;

public 的成员变量必须生成文档（JavaDoc）。proceted、private和 package 定义的成

员变量如果名字含义明确的话，可以没有注释。

存取方法

接下来是类变量的存取的方法。它只是简单的用来将类的变量赋值获取值的话，可以简单的

写在一行上。

/**

* Get the counters

* @return an array containing the statistical data. This array has been

* freshly allocated and can be modified by the caller.

*/

public int[] getPackets() { return copyArray(packets, offset); }

public int[] getBytes() { return copyArray(bytes, offset); }

public int[] getPackets() { return packets; }

public void setPackets(int[] packets) { this.packets = packets; }

其它的方法不要写在一行上

构造函数

接下来是构造函数，它应该用递增的方式写（比如：参数多的写在后面）。

访问类型 (public, private 等.) 和 任何 static, final 或 synchronized 应该在一行

中，并且方法和参数另写一行，这样可以使方法和参数更易读。

public

CounterSet(int size){

this.size = size;

}

克隆方法

如果这个类是可以被克隆的，那么下一步就是 clone 方法：

public

Object clone() {

try {

CounterSet obj = (CounterSet)super.clone();

obj.packets = (int[])packets.clone();

obj.size = size;

return obj;

}catch(CloneNotSupportedException e) {

throw new InternalError(Unexpected CloneNotSUpportedException: +

e.getMessage());

}

}

类方法

下面开始写类的方法：

/**

* Set the packet counters

* (such as when restoring from a database)

*/

protected final

void setArray(int[] r1, int[] r2, int[] r3, int[] r4)

throws IllegalArgumentException

{

//

// Ensure the arrays are of equal size

//

if (r1.length != r2.length || r1.length != r3.length || r1.length != r4.length)

throw new IllegalArgumentException(Arrays must be of the same size);

System.arraycopy(r1, 0, r3, 0, r1.length);

System.arraycopy(r2, 0, r4, 0, r1.length);

}

toString 方法

无论如何，每一个类都应该定义 toString 方法：

public

String toString() {

String retval = CounterSet: ;

for (int i = 0; i data.length(); i++) {

retval += data.bytes.toString();

retval += data.packets.toString();

}

return retval;

}

}

main 方法

如果main(String[]) 方法已经定义了, 那么它应该写在类的底部.

5、代码可读性

避免使用不易理解的数字，用有意义的标识来替代。

不要使用难懂的技巧性很高的语句。

源程序中关系较为紧密的代码应尽可能相邻。

6、代码性能

在写代码的时候，从头至尾都应该考虑性能问题。这不是说时间都应该浪费在优化代码上，而是我们时刻应该提醒自己要注意代码的效率。比如：如果没有时间来实现一个高效的算法，那么我们应该在文档中记录下来，以便在以后有空的时候再来实现她。

不是所有的人都同意在写代码的时候应该优化性能这个观点的，他们认为性能优化的问题应该在项目的后期再去考虑，也就是在程序的轮廓已经实现了以后。

不必要的对象构造

不要在循环中构造和释放对象

使用 StringBuffer 对象

在处理 String 的时候要尽量使用 StringBuffer 类，StringBuffer 类是构成 String 类的基础。

String 类将 StringBuffer 类封装了起来，（以花费更多时间为代价）为开发人员提供了一个安全的接口。当我们在构造字符串的时候，我们应该用 StringBuffer 来实现大部分的工作，当工作完成后将 StringBuffer 对象再转换为需要的 String 对象。比如：如果有一个字符串必须不断地在其后添加许多字符来完成构造，那么我们应该使用StringBuffer 对象和她的 append() 方法。如果我们用 String 对象代替StringBuffer 对象的话，会花费许多不必要的创建和释放对象的 CPU 时间。大家可以来安安DIY创作室一起讨论。

避免太多的使用 synchronized 关键字避免不必要的使用关键字 synchronized，应该在必要的时候再使用她，这是一个避免死锁的好方法。

7、编程技巧

byte 数组转换到 characters

为了将 byte 数组转换到 characters，你可以这么做：

Hello world!.getBytes();

Utility 类

Utility 类（仅仅提供方法的类）应该被申明为抽象的来防止被继承或被初始化。

初始化

下面的代码是一种很好的初始化数组的方法：

objectArguments = new Object[] { arguments };

枚举类型

JAVA 对枚举的支持不好，但是下面的代码是一种很有用的模板：

class Colour {

public static final Colour BLACK = new Colour(0, 0, 0);

public static final Colour RED = new Colour(0xFF, 0, 0);

public static final Colour GREEN = new Colour(0, 0xFF, 0);

public static final Colour BLUE = new Colour(0, 0, 0xFF);

public static final Colour WHITE = new Colour(0xFF, 0xFF, 0xFF);

}

这种技术实现了RED, GREEN, BLUE 等可以象其他语言的枚举类型一样使用的常量。

他们可以用 '==' 操作符来比较。

但是这样使用有一个缺陷：如果一个用户用这样的方法来创建颜色 BLACK new Colour(0,0,0)

那么这就是另外一个对象，'=='操作符就会产生错误。她的 equal() 方法仍然有效。由于这个原因，这个技术的缺陷最好注明在文档中，或者只在自己的包中使用。

8、编写格式

代码样式

代码应该用 unix 的格式，而不是 windows 的（比如：回车变成回车+换行）

文档化

必须用 javadoc 来为类生成文档。不仅因为它是标准，这也是被各种 java 编译器都认可的方法。使用 @author 标记是不被推荐的，因为代码不应该是被个人拥有的。

缩进

缩进应该是每行2个空格. 不要在源文件中保存Tab字符. 在使用不同的源代码管理工具时Tab字符将因为用户设置的不同而扩展为不同的宽度.如果你使用 UltrEdit 作为你的 Java 源代码编辑器的话，你可以通过如下操作来禁止保存Tab字符, 方法是通过 UltrEdit中先设定 Tab 使用的长度室2个空格，然后用 Format|Tabs to Spaces 菜单将 Tab 转换为空格。

页宽

页宽应该设置为80字符. 源代码一般不会超过这个宽度, 并导致无法完整显示, 但这一设置也可以灵活调整. 在任何情况下, 超长的语句应该在一个逗号或者一个操作符后折行. 一条语句折行后, 应该比原来的语句再缩进2个字符.

{} 对

{} 中的语句应该单独作为一行. 例如, 下面的第1行是错误的, 第2行是正确的:

if (i0) { i ++ }; // 错误, { 和 } 在同一行

if (i0) {

i ++

}; // 正确, { 单独作为一行

} 语句永远单独作为一行.如果 } 语句应该缩进到与其相对应的 { 那一行相对齐的位置。

括号

左括号和后一个字符之间不应该出现空格, 同样, 右括号和前一个字符之间也不应该出现空格. 下面的例子说明括号和空格的错误及正确使用:

CallProc( AParameter ); // 错误

CallProc(AParameter); // 正确

不要在语句中使用无意义的括号. 括号只应该为达到某种目的而出现在源代码中。下面的例子说明错误和正确的用法:

if ((I) = 42) { // 错误 - 括号毫无意义

if (I == 42) or (J == 42) then // 正确 - 的确需要括号

9、代码编译

1.编写代码时要注意随时保存，并定期备份，防止由于断电、硬盘损坏等原因造成代码丢失。

2.同一项目组内，最好使用相同的编辑器，并使用相同的设置选项。

3.合理地设计软件系统目录，方便开发人员使用。

4.打开编译器的所有告警开关对程序进行编译。

5.在同一项目组或产品组中，要统一编译开关选项。

6.使用工具软件（如Visual SourceSafe）对代码版本进行维护。如果大家有不明白的可以到安安DIY创作室留言。

10、可移植性

Borland Jbulider 不喜欢 synchronized 这个关键字，如果你的断点设在这些关键字的作用域内的话，调试的时候你会发现的断点会到处乱跳，让你不知所措。除非必须，尽量不要使用。

换行

如果需要换行的话，尽量用 println 来代替在字符串中使用\n。

你不要这样：

System.out.print(Hello,world!\n);

要这样：

System.out.println(Hello,world!);

或者你构造一个带换行符的字符串，至少要象这样：

String newline = System.getProperty(line.separator);

System.out.println(Hello world + newline);

PrintStream

PrintStream 已经被不赞成（deprecated）使用，用 PrintWrite 来代替它。

初学者学习java编程应该要注意什么

学java到底难不难，对于这个问题，我们专门做过一个调查，超过1000名已经在职的java从业者，其中有80%的程序员觉得学java不难，20%的程序员觉得前期有点难，其中对于50%自学的新手认为java很难学，遇到问题没人解答，又或者是答案太多，根本不知道哪个回答是正确的。所以，我们得出结论，能系统学习的，有老师指导的java课程学起来相对容易，而没有人指导，仅仅靠看视频学习的同学来说会无形中增加难度。

首先，java其实不像我们想的那么困难，但是决定要进入这行，前期就得有相应的心理准备，如果想走的远，就需要不断学习提升，特别是在初期，不能怕吃苦，不要老是想着玩游戏，空余时间多看看代码，设计架构，各个环节的功能与用途。

由于每个人对于问题的难易程度都有不同的标准，总是想着放弃的人，也会无形中给自己设置门槛，如果不是计算机专业毕业的新手朋友，准备转行做java时，往往有可能只是看到了工资高，却忽视了到底适不适合自己。所以，我们看问题不能只看到表面的东西，而应该从多方面去考虑，比如下面这6个方面：

1. 学习的过程中，一定要从小实验开始，逐步完成更多的综合性实验，千万不要盲目求大，这样做的结果往往会陷入一个学习的瓶颈。有的初学者在学习Java的初期就直接看一些案例的书，虽然案例没少做，但是还是无法形成自己的编程思路，原因就是没有通过一个系统的实验过程建立起自己的编程思维，这个是问题的关键。

2. 要熟悉一些简单的设计模式和编程原则。另外最好自己写过完整的工程，熟悉eclipse这样的工具。可以给HR展示自己所做的工程，然后通过讨论来将话题放到自己熟悉的部分。

3. 写的程序要格式清晰规范，可读性好，首行要缩进，成对的花括号，除了类的括号以外，最后都要处于同一列。这并不是强制的，每个人的习惯也不同，但是至少要 清晰规范，比如某人，从来就不把成对的花括号放在同一列，而是任由eclipse自动排版，虽然也很规范，但是我每次看她的代码都要把花括号改一改才舒 服，然后她又气哄哄的给改回去。

4. WEB也要熟悉一些。对于三层模式也要很熟悉，表示层、逻辑层和数据持久层。以上都是很基础的东西，稍微了解一下面试问题都不大，元程序(不是源程序)有时候也会问，但是不多，就是处理器层的处理过程，汇编一样关于寄存器和存储器的操作。

5.学习java不能总是把希望寄托于老师的身上，我们要学会多方位思考，举一反三，遇到问题总是第一时间想的是老师能不能帮帮我，最好是这段代码都由老师来代写了更好，其实这种思路会大大降低我们独立解决问题的能力，我更建议的是，大家在遇到问题时，先想办法自己解决，然后把解决方案拿到老师那里，帮你分析，到底是对的还是错的，又或者实在是解决不了，向老师详细的描述你的问题，老师看到了也会为你解答的，而不是一来就是这个代码怎么写，想寻求答案，先学会正确的提问。

6.我们在学习的过程中，应该有经验丰富的导师为自己指导，又或者是有相关工作经验的前辈们来指导自己，不要想着我看看网上的教程，几个月之后就能找到一份好工作，这是不现实的，如果没有好的导师帮你解决问题，相信对于一个新手来说，我们会走很多弯路，同时也会半途而废，浪费了自己的时间和金钱。

最后，Java编程语言的学习过程是一个从难到易的过程，由于Java编程的抽象程度比较高，所以对于很多初学者来说，需要一个理解的过程，但是当掌握了类、对象等基本概念之后，后面的学习就会顺利起来。如果想系统的学习编程的可以来我这看看，肯定对你有帮助的。

希望对您有所帮助！~

北大青鸟java培训：程序员如何规范代码的编写方法？

对于每个程序员来说，养成良好的代码编写方法是非常关键的。

在编写代码的过程中，每个人的方法是不同的，那么应该如何规范自己代码编写的方法呢？规范编写代码有哪些要求呢？下面电脑培训带大家认识代码编写的方法。

一、保证代码压缩后不会出错对于大的JavaScript项目，一般来说，包含在项目中的所有JavaScript文件在产品公开时都会被压缩。

为了正确压缩代码，通常需要考虑压缩工具的必要条件，如句子用分号正常结束，中括号结束等。

因此，IT培训发现当编写代码没有按照标准进行时，在发生压缩错误后再次寻找错误是浪费时间的。

二、保证代码能够通过自动格式化功能一般情况下需要使用完善的开发工具进行自动化格式功能，这个功能能够进行换行、缩进和空格等方法的代码编排，并且还可以设置自己喜欢的格式。

别人在阅读你的代码时需要使用IDE进行格式转换，以满足个人的阅读风格。

江苏北大青鸟认为阅读代码能够更加深入的了解代码调用和细节的实现，这是简单的文档不能实现的。

三、使用标准的文档注释这是编写代码中最基本的要求，能够很好的了解代码的提示，并且还可以利用配套的文档工具生产其他格式让别人阅读。

北大青鸟认为编写完整的注释还可以使团队成员更容易阅读您的代码。

通过您的参数描述，团队成员很容易了解您想要传递参与实现细节和编写的方法。

北大青鸟java培训：如何规范自己的代码编辑方式？

对于程序员来说，养成良好的代码写作能力是非常重要的。

今天，我们就一起来了解一下，规范化的代码编写都有哪些要求。

希望通过对本文的阅读，能够提高大家对于代码规范的认识。

1.保证代码压缩后不出错对于大型的JSP项目，一般会在产品发布时对项目包含的所有JSP文件进行压缩处理，比如可以利用GoogleClosureCompilerService对代码进行压缩，新版jQuery已改用这一工具对代码进行压缩，这一般会去掉开发时写的注释，除去所有空格和换行，甚至可以把原来较长的变量名替换成短且无意义的变量名，这样做的目的是加快文件的下载速度，同时也减小网站访问带来的额外数据流量，另外在代码保护上也起到了一点点作用，至少压缩后的代码即使被还原还是没那么容易一下读懂的。

要想代码能正确通过压缩，一般要求语句都要以分号正常结束，大括号也要严格结束等，具体还要看压缩工具的要求。

所以如果一开始没有按标准来做，等压缩出错后再回去找错误那是浪费时间。

2.保证代码能通过特定IDE的自动格式化功能一般较为完善的开发工具(比如AptanaStudio)都有代码"自动格式"化功能，这一功能帮助实现统一换行、缩进、空格等代码编排，你可以设置自己喜欢的格式标准，比如左大括号{是否另起一行。

达到这个要求的目的在于方便你的开发团队成员拿你代码的一个副本用IDE自动格式化成他喜欢或熟悉的风格进行阅读。

你同事需要阅读你的代码，可能是因为你写的是通用方法，他在其它模块开发过程中也要使用到，阅读你的代码能深入了解方法调用和实现的细节，这是简单API文档不能达到的效果。

3.使用标准的文档注释这一要求算是基本的，这有利于在方法调用处看到方法的具体传参提示，也可以利用配套文档工具生成html或其它格式的开发文档供其他团队成员阅读，你可以尝试使用jsdoc-toolkit。

如果你自动生成的API是出自一个开放平台，就像facebook.com应用，那么你的文档是给天下所有开发者看的。

另外编写完整注释，也更方便团队成员阅读你的代码，通过你的参数描述，团队成员可以很容易知道你编写的方法传参与实现细节。

当然也方便日后代码维护，这样即使再大的项目，过了很长时间后，回去改点东西也就不至于自己都忘记了当时自己写的代码是怎么一回事了。

4.使用规范有意义的变量名使用规范有意义的变量名可以提高代码的可读性，作为大项目开发成员，自己写的代码不仅仅要让别人容易看懂。

电脑培训认为开发大项目，其实每个人写的代码量可能都比较大，规范命名，日后自己看回自己的代码也显的清晰易懂，比如日后系统升级或新增功能，修改起代码来也轻松多了。

如果到头发现自己当初写的代码现在看不太懂了，那还真是天大的笑话了。

java程序员有哪些应该注意的编码规范?

Java编码规范:　尽量使用完整的英文描述符采用适用于相关领域的术语采用大小写混合使名字可读尽量少用缩写，但如果用了，必须符合整个工程中的统一定义避免使用长的名字（小于15个字母为正常选择）避免使用类似的名字，或者仅仅是大小写不同的名字避免使用下划线（除静态常量等）标识符类型说明包（Package）的命名Package的名字应该采用完整的英文描述符，都是由一个小写单词组成。并且包名的前缀总是一个顶级域名

，通常是com、edu、gov、mil、net、org等；如：com.yjhmily.test类（Class）的命名类名应该是个一名词，采用大小写混合的方式，每个单词的首字母大写。尽量保证类名简洁而富于描述。

本文名称：java代码规范指南 JAVA代码规范
本文链接：http://azwzsj.com/article/docgeip.html