java程序的编程规范

一、Java程序的基本结构

一个Java应用程序是由若干个源程序文件组成，每个程序包括以下要素。
（1）包的声明语句，以package关键字开始。
（2）若干个引入包的语句，以import 关键字开始。
（3）定义若干个类，定义类的关键字为class。
（4）定义若干个接口，定义接口的关键字为interface。
（5）在主类中定义入口方法main。
（6）将应用程序的主要流程或运行逻辑写入main方法的方法体中。
二、java注释

java提供了3种类型的注释，具体如下所诉。
（1）单行注释，使用符号“//”。程序中从’“//”开始到当前行结束的所有字符都是注释的内容，通常在注释内容较少的时候使用。

float r ,s;     //声明变量
r=5;            //赋值语句
s=3.14*r*r;     //求圆的面积

（2）多行注释，使用符号对“/* ”和“*/ ”之间的文本都是注释的内容，可以是一行，也可以是多行。通常用在注释内容较多、跨越多行的情形，如果注释内容需要跨越多行，在中间每一行的前面尽量加上一个 *，这样结构比较清晰。
注释一行

/*以下程序段用来求圆的面积*/
float r,s;
r=5;
s=3.14*r*r;

注释多行

/*
*以下程序段用来求圆的面积
*r表示圆的面积
*/
flost r,s;
r=5;
s=3.14*r*r;

（3）文档注释，使用符号对“/**”和“*/”。文档注释具有两方面的功能：一方面起到注释程序的作用，另一方面可以被java系统的注释文档生成器命令javadoc.exe生成应用程序的注释文档，该文档类似于API文档，为HTML格式。例如在源程序文件开头列出类名、版本信息、作者、日期、版权声明等。
三、java代码格式编写规范
为了提高程序的可读性，在书写java源程序时，要注意以下原则。
（1）java对大小写敏感，严格区分大小写。
（2）每一条语句都以半角的（;）结束。
（3）尽管java格式自由，但一行最好只写一条语句。
（4）为程序可读性与可维护性起见，尽可能在必要处加上注释。
（5）源程序尽量使用代码缩进的编排方式。尽量不要用tab制表符，使用不同的源代码管理工具时，tab字符将因为用户设置的不同而扩展为不同的宽度。
（6）尽量避免一行的长度超过80个字符，因为很多终端和工具不能很好地处理，但这一设置可以灵活进行调整。当一个语句或表达式无法容纳在一行内时，可以在一个逗号后面或一个操作符前面断开，但折行后，应该比原来的语句再缩进两个以上字符。