java 源代码注释

import java.awt.*;

成都创新互联专注于企业网络营销推广、网站重做改版、五原网站定制设计、自适应品牌网站建设、HTML5建站、商城网站定制开发、集团公司官网建设、成都外贸网站建设、高端网站制作、响应式网页设计等建站业务，价格优惠性价比高，为五原等各大城市提供网站开发制作服务。

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import javax.swing.*;

public class GameTest extends JFrame implements ActionListener{

/*

* 新建一个主面板(这个类可能是自定义的，本程序和API中没有)。

*/

MainPanel j=new MainPanel();

JButton jPreview;

JLabel label;

Container container;

JPanel panel;

/**

* 主函数

* @param args

*/

public static void main(String[] args) {

//运行程序

new GameTest();

}

/**

* 构造函数。

*

*/

public GameTest()

{

//新建一个标题为“拼图”的窗口

JFrame fr =new JFrame("拼图");

//获取窗口容器。

container=fr.getContentPane();

//创建菜单条

JMenuBar jMenuBar=new JMenuBar();

//以下初始化菜单，并且设置快捷键和添加监听器。

JMenu jMenuGame=new JMenu("游戏(G)");

jMenuGame.setMnemonic('g');

JMenuItem jMenuItemStart = new JMenuItem("开始(S)");

jMenuItemStart.setMnemonic('s');

jMenuItemStart.addActionListener(this);

JMenuItem jMenuItemExit=new JMenuItem("退出(E)");

jMenuItemExit.setMnemonic('e');

jMenuItemExit.addActionListener(this);

jMenuGame.add(jMenuItemStart);

jMenuGame.add(jMenuItemExit);

//初始化按钮并设置快捷键和添加监听器

JButton jChoice=new JButton("选图(X)");

jChoice.setMnemonic('x');

jChoice.addActionListener(this);

jPreview=new JButton("预览(P)");

jPreview.setMnemonic('p');

jPreview.addActionListener(this);

//将菜单和按钮添加到菜单条中

jMenuBar.add(jMenuGame);

jMenuBar.add(jChoice);

jMenuBar.add(jPreview);

//将菜单条设为该窗口的主菜单

fr.setJMenuBar(jMenuBar);

//将主面板添加到该窗口的容器中。

container.add(j);

//设置大小

fr.setSize(315,360 );

fr.setVisible(true);

//设置默认关闭方式。

fr.setDefaultCloseOperation(3);

}

/**

* 事件处理函数。

*/

public void actionPerformed(ActionEvent e) {

if(e.getActionCommand()=="开始(S)")

{

j.Start();

}

if(e.getActionCommand()=="预览(P)")

{

j.setVisible(false);

panel=new JPanel();

Icon icon=new ImageIcon("pictrue/pic"+"_"+MainPanel.pictureID+".jpg");

label=new JLabel(icon);

label.setBounds(300, 300, 0, 0);

panel.add(label);

panel.setSize(300, 300);

panel.setVisible(true);

this.container.add(panel);

jPreview.setText("返回(P)");

}

if(e.getActionCommand()=="返回(P)")

{

panel.setVisible(false);

j.setVisible(true);

j.repaint();

jPreview.setText("预览(P)");

}

if(e.getActionCommand()=="退出(E)")

{

System.exit(0);

}

if(e.getActionCommand()=="选图(X)")

{

//初始化选择框，并提供选择。

Choice pic = new Choice();

pic.add("七里香");

pic.add("依然范特西");

pic.add("八度空间");

pic.add("十一月的肖邦");

pic.add("魔杰座");

pic.add("叶惠美");

pic.add("我很忙");

int i=JOptionPane.showConfirmDialog(this, pic, "选择图片", JOptionPane.OK_CANCEL_OPTION);

if(i==JOptionPane.YES_OPTION)

{

//选择图片

MainPanel.pictureID=pic.getSelectedIndex()+1;

j.removeAll();

j.reLoadPicture();

j.repaint();

}

}

}

}

代码注释率占比20%合适

一般占 30%-40%

也不是这样确定，

首先是要在程序的开头写上这段代码的作用，或者自己为什么要写着一段代码

逻辑性很强的地方加上注释，使读者不用在头脑中仿真代码的运行过程

比如在 if 语句 for 语句，要是用到了一些比较复杂的算法，还要写的更清晰一些

祝你学习愉快

一般占 30%-40 也不是这样确定，首先是要在程序的开头写上这段代码的作用，或者自己为什么要写着一段代码 逻辑性很强的地方加上注释，使读者不用在头脑中仿真代码的运行过程 比如在 if 语句 for 语句，要是用到了一些...注释不重要，所有变量和方法注释，还有一些关键方法解释说明一下就够了 重要的是清晰的架构，文档 类图 你只要能让下一个拿到你代码的人看看文档就明白怎么回事就ok

求一份软件测试的报告,大体上要写什么,格式怎么样的。求救。我做的是... —— 2 引用文档《XX软件需求规格说明》《XX软件设计说明》《XX系统接口协议》3 测试概述3.1被测软件的基本概况使用的编程语言:XXX 汇编语言程序行数:1590子程序个数:11单行注释行数:669注释率:约为42%3.1.1. 测试小结本次测试对XX软件进...

软件测试报告怎么写 —— 2 引用文档《XX软件需求规格说明》《XX软件设计说明》《XX系统接口协议》3 测试概述3.1被测软件的基本概况使用的编程语言:XXX 汇编语言程序行数:1590子程序个数:11单行注释行数:669注释率:约为42%3.1.1. 测试小结本次测试对XX软件进...

java源程序的注释量必须在多少以上？

一般编程在1/4~1/3就可以了，其实编程的时候不单要关注注释的量，还要写的清晰、明了。注释的多少不是主要的，关键是能让别人看的时候能看明白。

另外在命名是也要特别注意，命名能都充分表现你的变量、方法、类的含义，这样也能起到注释的作用。

还有就是类、方法不能过大，方法十几行也就差不多了，太多可读性就比较差了。

java工作中良好的代码注释习惯是什么

注释是为了方便自己或代码维护方更容易地读懂代码的用处。

一、背景 

1、当我们第一次接触某段代码，但又被要求在极短的时间内有效地分析这段代码，我们需要什么样的注释信息？ 

2、怎么样避免我们的注释冗长而且凌乱不堪呢？ 

3、在多人协同开发、维护的今天，我们需要怎么样的注释来保证高质、高交的进行开发和维护工作呢？ 

二、意义 

程序中的注释是程序设计者与程序阅读者之间通信的重要手段。应用注释规范对于软件本身和软件开发人员而言尤为重要。并且在流行的敏捷开发思想中已经提出了将注释转为代码的概念。好的注释规范可以尽可能的减少一个软件的维护成本 , 并且几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护。好的注释规范可以改善软件的可读性，可以让开发人员尽快而彻底地理解新的代码。好的注释规范可以最大限度的提高团队开发的合作效率。长期的规范性编码还可以让开发人员养成良好的编码习惯，甚至锻炼出更加严谨的思维能力。 

三、注释的原则 

1、 注释形式统一 

在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其他项目组发现他们的注释规范与这份文档不同，按照他们的规范写代码，不要试图在既成的规范系统中引入新的规范。 

2、 注释的简洁 

内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。 

3、 注释的一致性 

在写代码之前或者边写代码边写注释，因为以后很可能没有时间来这样做。另外，如果有机会复查已编写的代码，在今天看来很明显的东西六周以后或许就不明显了。通常描述性注释先于代码创建，解释性注释在开发过程中创建，提示性注释在代码完成之后创建。修改代码的同时修改相应的注释，以保证代码与注释的同步。 

4、 注释的位置 

保证注释与其描述的代码相邻，即注释的就近原则。对代码的注释应放在其上方相邻或右方的位置，不可放在下方。避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释要对齐。 

5、 注释的数量 

注释必不可少，但也不应过多，在实际的代码规范中，要求注释占程序代码的比例达到20%左右。注释是对代码的“提示”，而不是文档，程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱，注释的花样要少。不要被动的为写注释而写注释。 

6、删除无用注释 

在代码交付或部署发布之前，必须删掉临时的或无关的注释，以避免在日后的维护工作中产生混乱。 

7、 复杂的注释 

如果需要用注释来解释复杂的代码，请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码，而应该重写它。尽管一般不应该为了使代码更简单便于使用而牺牲性能，但必须保持性能和可维护性之间的平衡。 

8、 多余的注释 

描述程序功能和程序各组成部分相互关系的高级注释是最有用的，而逐行解释程序如何工作的低级注释则不利于读、写和修改，是不必要的，也是难以维护的。避免每行代码都使用注释。如果代码本来就是清楚、一目了然的则不加注释，避免多余的或不适当的注释出现。 

9、必加的注释 

典型算法必须有注释。在代码不明晰或不可移植处必须有注释。在代码修改处加上修改标识的注释。在循环和逻辑分支组成的代码中添加注释。为了防止问题反复出现，对错误修复和解决方法的代码使用注释，尤其是在团队环境中。 

10、注释在编译代码时会被忽略，不编译到最后的可执行文件中，所以注释不 

会增加可执行文件的大小。 

四、JAVA注释技巧 

1、空行和空白字符也是一种特殊注释。利用缩进和空行，使代码与注释容易区 

别，并协调美观。 

2、当代码比较长，特别是有多重嵌套时，为了使层次清晰，应当在一些段落的 

结束处加注释（在闭合的右花括号后注释该闭合所对应的起点），注释不能 

写得很长，只要能表示是哪个控制语句控制范围的结束即可，这样便于阅读。 

3、将注释与注释分隔符用一个空格分开，在没有颜色提示的情况下查看注释时， 

这样做会使注释很明显且容易被找到。 

4、不允许给块注释的周围加上外框。这样看起来可能很漂亮，但是难于维护。 

5、每行注释（连同代码）不要超过120个字(1024×768)，最好不要超过80 

字(800×600) 。 

6、Java编辑器（IDE）注释快捷方式。Ctrl+/ 注释当前行,再按则取消注释。 

7、对于多行代码的注释，尽量不采用“/*......*/”，而采用多行“//”注释， 

这样虽然麻烦，但是在做屏蔽调试时不用查找配对的“/*......*/”。 

8、注释作为代码切换开关，用于临时测试屏蔽某些代码。

java语法基础,具体内容

Java基础——Java开发前奏

Java的特点

Java最主要的特点是：一次编译，到处运行（Write Once, Run Anywhere.）。

原理：Java源程序经编译后生成.class字节码文件，.class文件由Java虚拟机（JVM）解释执行。不同的操作系统下，只要有相应的Java字节码解释程序，.class文件就能够运行，这是Java跨平台性的根本。c和java编程与执行的过程如下图所示：

Java的内涵

1、是一种编程语言

2、是一套开发工具

3、是一个运行环境

Java应用平台

1、J2EE（Java 2 Platform Enterprise Edition）——用于企业级应用程序的开发

2、J2SE（Java 2 Platform Standard Edition）——用于普通标准应用程序的开发

3、J2ME（Java 2 Platform Micro Edition）——用于小型消费类电子产品或嵌入式系统的开发

J2SE包括4部分——JVM、JRE、JDK与Java语言。

环境变量的设置

环境变量——在操作系统中定义的变量，可供操作系统上所有的应用程序使用。

1、查看环境变量

a.命令提示行：环境变量的命令——set （环境变量名）

b.窗口方式：我的电脑-属性-高级-环境变量

2、设置path环境变量

path环境变量的作用：设置操作系统寻找和执行应用程序的路径。

JAVA_HOME：C:\Program Files\Java\jdk1.6.0_14

path：%JAVA_HOME%\bin;%JAVA_HOME%\jre\bin

3、设置classpath环境变量

classpath环境变量的作用：让Java执行环境找到指定的java程序（.class文件）。

classpath：.;%JAVA_HOME%\lib\dt.jar;%JAVA_HOME%\lib\tools.jar

注意：a.%JAVA_HOME%前面有“.;”，“.”表示当前目录，两个路径之间用“;”隔开。

b.设置classpath的路径中不能有空格，也不能有中文字符。

JVM的运行过程

Java反编译工具——JAD、FrontEnd

Java开发工具

1、记事本

注意保存时文件名应为*.java。

2、UltraEdit、EditPlus

使用EditPlus编辑和编译Java程序，需要进行相应配置。选择“工具”-“参数选择”-“工具”-“用户工具”-“添加工具”-“应用程序”。首先设置“javac”的参数，具体如下图，其中“命令”为javac.exe文件的地址。

然后设置“java”的参数，如下图所示，其中“命令”为java.exe文件的路径。

设置好后默认“javac”工具的快捷键为Ctrl+1，“java”工具的快捷键为Ctrl+2。当编辑好Java源程序后，使用Ctrl+1即可对其进行编译，然后按Ctrl+2运行程序。如下图所示：

3、集成开发环境——Eclipse、MyEclipse、JBuilder等。

关于Eclipse和MyEclipse，刚用的时候感觉二者差不多，查了资料才知道Eclipse 是基础，如同操作系统；而MyEclipse是在Eclipse上面运行的程序，不过进行了增强并提供了新功能。

以前用过Microsoft的Visual Studio 2005，个人感觉VS2005是一个功能非常强大的集成开发环境，不过.NET和Java毕竟不是一家人，学Java还是要用Eclipse的。

JDK中的常用包

1、java.lang——包含一些Java语言的核心类，如String、Math、Thread、System、Integer类等。

2、java.awt——包含构成抽象窗口工具集的多个类，用来构建和管理应用程序的图形用户界面（GUI）。

3、java.applet——包含applet运行所需的一些类。

4、java.net——包含执行与网络相关操作的类。

5、java.io——包含能提供多种输入/输出功能的类。

6、java.util——包含一些实用工具类。

Java的命名习惯

1、包名中的字母一律小写。如：xxxyyyzzz。

2、类名、接口名应使用名词，每个单词的首字母大写。如：XxxYyyZzz。

3、方法名，第一个单词小写，后面每个单词的首字母大写。如：xxxYyyZzz。

4、变量名，第一个单词小写，后面每个单词的首字母大写。

5、常量名中的每个字母一律大写。如：XXXYYYZZZ。

Java基础——Java语法基础（1）

Java代码基本格式

Java中所有程序代码都必须存在于一个类中，用class关键字定义类，在class之前可以有一些修饰符。格式如下：

修饰符 class 类名

{

程序代码

}

注：

1、Java是严格区分大小写的。

2、Java程序中一句连续的字符串不能分开在两行中写。

Java程序的注释

Java里的注释有三种类型：

1、单行注释

在注释内容前面加“//”，格式为：

代码;  //注释内容

2、多行注释

以斜杠加星号开头，以星号加斜杠结尾。

3、文档注释

以斜杠加两个星号开头，以一个星号加斜杠结束。

用这种方法注释的内容会被解释成程序的正式文档，并能包含进诸如javadoc之类的工具程序生成的文档里，用以说明该程序的层次结构及其方法。

补充：

1、多行注释中可以嵌套“//”注释，但不能嵌套多行注释符号。

2、程序注释一般占程序代码总量的20%-50%，“可读性第一，效率第二”。

Java中的标识符

Java中的包、类、方法、参数、变量的名字，可以由任意顺序的大小写字母、数字、下划线（_）、美元符号（$）组成，但不能以数字开头，不能是Java中的保留关键字。

Java的关键字

1、用于类和接口的声明：class, extends, implements, interface

2、包引入和包声明：import, package

3、数据类型：byte, boolean, char, double, int, long, float, short

4、某些数据类型的可选值：flase, ture, null

5、流程控制：break, case, continue, default, do, else, for, if, return, switch, while

6、异常处理：catch, finally, throw, throws, try

7、修饰符：abstract, final, native, private, protected, public, static, synchronilzed, transient, volatitle

8、操作符：instanceof

9、创建对象: new

10、引用：this, supper

11、方法返回类型：void

12、保留字：const, goto

Java中的常量

1、整形常量

十进制

十六进制——以0x或0X开头

八进制——以0开头

长整形——以L(l)结尾

2、浮点数常量

单精度浮点数——后面加f(F)

双精度浮点数——后面加d(D)

注：

a.小数常量的默认类型是double型，所以float类型常量后一定要加f(F)。

b.浮点数常量可以用指数形式表示，如5.022e+23f

3、布尔常量

true或false

4、字符常量

由英文字母、数字、转义序列、特殊字符等的字符所表示，如'a'、'\t'等。

Java中的字符占两个字节，是用Unicode码表示的，也可以使用'\u'加Unicode码值来表示对应字符，如'\u0027'。

常用的转义字符有：

\t——表示接受键盘输入，相当于按了一下回车键

\n——表示换行

\t——表示制表符，相当于Tab键

\b——表示退格键，相当于Back Space键

\'——表示单引号

\”——表示双引号

\\——表示反斜杠“\”

5、字符串常量

字符串常量用双引号括起来。

6、null常量

null常量表示对象的引用为空。

Java的变量类型

基本数据类型之间的转换

1、自动类型转换（隐式类型转换）

条件：

a.两种类型彼此兼容

b.目标类型的取值范围要大于源类型

2、强制类型转换（显示类型转换）

格式：目标类型 常量 = （目标类型）值

注：字符串可以使用加号“+”同其他的数据类型相连而形成一个新的字符串。

变量的作用域

代码块决定了变量的作用域，作用域决定了变量的可见性和存在时间。

局部变量

在一个函数或函数里面的代码块中定义的变量称为局部变量。

局部变量在进行取值操作前必须被初始化或进行过赋值操作。

函数

1、定义函数的格式

返回值类型 函数名（参数类型 形式参数1，参数类型形式参数2，...）

{

程序代码

return 返回值;

}

2、函数的重载

函数的重载就是在一个类中可以同时存在一个以上的同名函数，只要它们的参数个数或类型不同即可。

Java基础——Java语法基础（2）——运算符

Java中的运算符

1、算术运算符

a.字符串 + 其他类型 = 字符串

b.如果对负数求余，可以把除数负号忽略不计，如5 % -1 = 1。但如果被除数是负数就另当别论了。

2、赋值运算符

a.在Java中，可以把赋值语句连在一起，如：x = y = z = 5;

b.x += y相当于x = x + y

3、比较运算符

a.要注意比较运算符“==”和赋值运算符“=”的区别，特别是布尔型变量进行比较时。

b.可以将比较运算的表达式写为“false == 变量”的形式，以防止误写为赋值运算。

4、逻辑运算符

a.逻辑运算符用于对boolean型结果的表达式进行运算，运算的结果都是boolean型 。

b.“”和“”的区别在于，如果使用前者连接，那么无论任何情况，“”两边的表达式都会参与计算。如果使用后者连接，当“”的左边为false，则将不会计算其右边的表达式。“|”和“||”的区别与“”和“”的区别一样。

5、位运算符

位运算——对数据按二进制位进行移位操作。

适用类型：byte, short, char, int, long

位运算包括：

位与

| 位或

^ 位异或

左移，左移n位相当于乘以2的n次方

右移，右移n位相当于除以2的n次方

无符号右移

注：

a.位运算符也可以与“=”赋值运算符组合产生新的赋值运算符，如：=, =等。

b.移位不会改变变量本身的值，如a1在一行语句中单独存在毫无意义。

c.对低于int型的操作数将先自动转换为int型再移位；对int型整数移位ab，系统先将b对32取模，得到的结果才是真正移位的位数；对于long型整数移位时则是先将移位位数对64取模。

运算符的优先级

编程技巧：

1、不要在一行中编写太复杂的表达式，可以将其分解为几条语句。

2、多用括号。

Java基础——Java语法基础（3）

程序控制流程

1、顺序结构

按顺序执行

2、if条件语句

a.if...

b.if...else...

可简写为：变量 = 布尔表达式? 语句1:语句2;

c.if...else if...else...

3、switch选择语句

switch(表达式)

{

case 取值1:

语句块1;

break;

...

case 取值n:

语句块n;

break;

default:

语句块n+1;

break;

}

4、while循环语句

while(条件表达式)

{

执行语句

}

5、do while循环语句

do

{

执行语句

}while(条件表达式)

6、for循环语句

for(初始化表达式;循环条件表达式;循环后操作表达式)

{

执行语句

}

7、增强for循环

for (循环变量类型 循环变量名称: 要被遍历的对象)

{

执行语句

}

8、break与continue语句

a.一个无标号的break语句会把控制传回当前最内层循环（while,do,for,switch）的下一条语句。

b.无标号的continue语句的作用是跳过当前循环的剩余语句块，接着执行下一次循环。

数组

1、数组的定义

如：int[] x = new int[100];

或int x[] = new int[100];

2、数组的静态初始化

如：int[] aa = new int[] {3,4,5};

3、多维数据

如：

int[][] xx = new int[3][];

xx[0] = new int[3];

xx[1] = new int[2];

4、一些与数组相关的函数

a. System.arraycopy(Object src,int srcPos,Object dest,int destPos,int length)复制数组，将源数组srcPos开始的length个元素从目标数组的destPos位置开始存储。

b. Array.sort()数组升序排序

网站栏目：包含java代码注释率20%的词条
分享链接：http://hbruida.cn/article/hgieoe.html