java编程代码注释 Java代码注释

为什么要为程序添加注释,在java程序中如何为程序添加注释?

注释是用来给开发者或者是软件后续的维护者来看的。一般是用来描述这一段代码或者是程序做了些什么样的事情。实现了哪些功能,java里面注释代码,可以分为行注释和块注释,方法注释等。

创新互联公司主营石嘴山网站建设的网络公司,主营网站建设方案,app软件开发,石嘴山h5微信小程序开发搭建,石嘴山网站营销推广欢迎石嘴山等地区企业咨询

行注释就是在需要注释的代码前加 //

块注释则是用 /* 和 */ 把文本段落框起来即可

java 中的几种注释方式

我看动力节点的java基础大全301集教中的三种注释方法:

1、单行注释   //注释的内容

2、多行注释  /*......*/

3、/**......*/,这种方式和第二种方式相似。这种格式是为了便于javadoc程序自动生成文档。

下面介绍一下Javadoc的标记:

特别声明:

(1)javadoc针对public类生成注释文档

(2)javadoc只能在public、protected修饰的方法或者属性之上

(3)javadoc注释的格式化:前导*号和HTML标签

(4)javadoc注释要仅靠在类、属性、方法之前

下面主要举例说明第三种注释的应用:

(1)首先编写.java文件

(2)在命令行中执行以下dos命令:

javadoc *.java //根据相应的Java源代码及其说明语句生成HTML文档

//javadoc标记:是@开头的,对javadoc而言,特殊的标记。

(3)在当前目录下就会产生doc文件夹,里面有一系列的.html文件

附上代码:

[java] view plain copy

span style="font-size:18px;"*/

/**javadoc注释的内容

*/

public class Hello{

/**属性上的注释*/

public String name;

/**这是main方法,是程序的入口

*@param args 用户输入参数

*/

public static void main(String[] args){

System.out.println("Hello World!");

f1();

}

/** 这是第1个方法,其作用是...*/

public static void f1(){

System.out.println("f1()!");

}

}/span

[java] view plain copy

span style="font-size:18px;"import java.io.IOException;

/**javadoc注释内容

*@since 1.0

*@version 1.1

*@author Blue Jey

*br链接到另一个文档{@link Hello},就这些

*see Hello

*/

public class HelloWorld{

/**非public,protected 属性上的注释不生成*/

public String name;

/**这是main方法,是程序的入口

*@param args 用户输入的参数,是数组

*@throws IOException main方法io异常

*/

public static void main(String args[]) throws IOException{

System.out.println("hello World!");

f1();

f2(1);

}

/**这是第一个方法,其作用是....

*@deprecated 从版本1.2开始,不再建议使用此方法

*/

public static void f1(){

System.out.println("fl()!");

}

/**这是第二个方法,其作用是....

*@return 返回是否OK

*@param i 输入参数i

*@see Hello

*@throws IOException io异常

*/

public static String f2(int i)throws IOException{

System.out.println("f1()!");

return "OK";

}

} /span

注意:

如果源文件中有用到@version,@author标记,则在执行javadoc命令时,要加-version -author

javadoc -version -author -d doc *.java

(其中用-version用于提取源文件中的版本信息 -author用于提取源文件中的作者信息)

java代码每一句的注释

import java.awt.*;   //awt的图形包

import javax.swing.*;//swing的图形包

import java.io.*; //IO流处理包

import java.awt.event.*; //事件处理包

public class CDInfor extends JFrame implements ActionListener//继承swing 的Frame 实现 事件接口 

{

BufferedReader in;  //输入输出管道流

FileWriter out;

JPanel jPanel1 = new JPanel(); //定义 6个Jpanel(容器)用来装组件 (就是你按钮什么的)

JPanel jPanel2 = new JPanel(new GridLayout(4,1)); //其中这个是  用网格的布局管理器

JPanel jPanel3 = new JPanel();

JPanel jPanel5 = new JPanel();

JPanel jPanel4 = new JPanel();

JPanel jPanel6 = new JPanel();

JScrollPane jScrollPane1 = new JScrollPane(); //定义滚动条

JTextArea jTextArea1 = new JTextArea("",10,25); //定义输入框

GridLayout gridLayout1 = new GridLayout(); //整体用的事 网格布局管理器

JTextField jTextField1 = new JTextField(10);  //文本输入框

JTextField jTextField2 = new JTextField(10); 

JTextField jTextField3 = new JTextField(10); 

JLabel jLabel1 = new JLabel("唱片编号:"); //定义显示的字 (只用来显示字)

JLabel jLabel2 = new JLabel("唱片名称:");

JLabel jLabel3 = new JLabel("歌手姓名:");

JButton jButton1 = new JButton("增加"); //定义按钮

JButton jButton2 = new JButton("取消");

String str;

public CDInfor() { //构造方法 程序启动的时候 或者调用这个类的时候执行(这里是程序启动)

try {

setDefaultCloseOperation(EXIT_ON_CLOSE);    //天剑程序关闭的方法 要不然 你点关闭 界面没了 但是资源没释放

jbInit(); //调用jbInit()方法 用于实现事件

}

catch (Exception exception) { //错误捕捉

exception.printStackTrace();

}

}

public void jbInit()

{

Container cp = getContentPane(); //定义一个pane的容器

cp.setLayout(new BorderLayout()); //布局为边框布局

jButton1.addActionListener(this); //将按钮1 绑定事件

jButton2.addActionListener(this); //将按钮2 绑定事件

jTextArea1.setEditable(false); //将这个输入框设定为不可编辑

jScrollPane1.getViewport().add(jTextArea1); //滚动条和jTextArea1绑定

jPanel3.add(jLabel1); jPanel3.add(jTextField1);   //将各个组件加入Jpanel里

jPanel4.add(jLabel2); jPanel4.add(jTextField2);

jPanel5.add(jLabel3); jPanel5.add(jTextField3);

jPanel6.add(jButton1); jPanel6.add(jButton2);

jPanel1.add(jScrollPane1);

jPanel2.add(jPanel3); jPanel2.add(jPanel4); jPanel2.add(jPanel5); jPanel2.add(jPanel6);

jPanel2.setPreferredSize(new Dimension(10, 150));

cp.add("Center",jPanel1);

cp.add("South",jPanel2);   

}

public void actionPerformed(ActionEvent e) //实现事件监听

{

if(e.getSource()==jButton1) //如果当前是 按钮一的话

{

try {} 

catch (Exception ex) {}

}

jTextField1.setText("");  //内容全部清空

jTextField2.setText("");

jTextField3.setText("");

}

public static void main(String[] args) throws Exception

{

CDInfor kk = new CDInfor(); //应为main是Static 所以 要new 本身类

kk.setSize(350,350); //设定大小

kk.setTitle("Please caculat:"); //设定标题栏文字

kk.setVisible(true); //是否显示 这个窗口

}

}

还不够详细么亲~ 采纳吧~~

Java代码注释

ResourceBundle res;

//打开对应的db.prop属性文件文件,和你的java class同一目录下

res = ResourceBundle.getBundle("db");

//从文件中取得ulr, user, password, jdbc driver名字

String url=res.getString("url");

String user=res.getString("user");

String password=res.getString("password");

String className = res.getString("classname");

try{

//初始化你的jdbc dirver

Class.forName(className).newInstance();

//建立connection

conn = DriverManager.getConnection(url,user,password);

}catch(Exception e)

{

e.printStackTrace();

}

return conn;


分享名称:java编程代码注释 Java代码注释
URL标题:http://hbruida.cn/article/dooijid.html