如何写Java文档注释

/**

创新互联建站"三网合一"的企业建站思路。企业可建设拥有电脑版、微信版、手机版的企业网站。实现跨屏营销，产品发布一步更新，电脑网络+移动网络一网打尽，满足企业的营销需求！创新互联建站具备承接各种类型的成都网站设计、网站制作、外贸营销网站建设项目的能力。经过10多年的努力的开拓，为不同行业的企事业单位提供了优质的服务，并获得了客户的一致好评。

* @author

* @param name

* @copy

*/

表示的是文档注释，文档注释里可以以作者名，参数的意义，版本等等。对于方法的文档注释，可以在方法的上面输入逗/**地按回车，就会出来了

如何写好java代码注释

写代码的时候，有时候，你需要写一些注释，把内容相互关联起来，方便自己或别人看的时候，可以直接找到你关联的代码类或者啥的。

这个时候，{@link}与@see，这2个javadoc注解就派上用场了，

不管他具体有什么功能，咱就只管一个，他可以链接代码，让注释看的更清楚易懂。方便你我他。

@see 标签允许用户引用其他类的文档。具体使用方式如下：

@see classname

@see fully-qualified-classname

@see fully-qualified-classname#方法名称

@see fully-qualified-classname#属性名称

我在使用的时候，发现这个只能单独一行顶头写，如果不顶头写就不管用了，没了链接的效果。

但是，{@link}这个却可以随便放。

具体使用方法和上面那个@see是一样的。

实际效果，看下面的图

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程序中加入注释？

试想一下，一个没有一句注释的程序源码，怎么读，一个程序要上万条代码不可能全部记得住哪一块是什么用，而且一个项目也不会是一个人独自完成，那样效率太低，多人合作就要给别人说明，每一块是什么用，方便他人使用，方便自己更正，而这些说明文字就是注释，注释不会被执行，不影响运行结果。

Java中代码的注释有三种：

// 注释一行 

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

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

前两种比较容易理解，至于第三种，你学习Java看的api文档就是javadoc程序根据第三种的注释生成的。

扩展资料

注释就是对代码的解释和说明，其目的是让人们能够更加轻松地了解代码。注释是编写程序时，写程序的人给一个语句、程序段、函数等的解释或提示，能提高程序代码的可读性。

java 语句如何注释

单行注释 // 快捷键 Ctrl+/

// M4_4aaForm fr = (M4_4aaForm) form;

多行注释 /*

*

*/

生成帮助文档的注释

/**

* Function: Action実行br

*

* Produce Describe:

*

* @param mapping

* @param form

* @param request

* @param response

* @return

* @throws SysException

* @throws DBException

*/

分享文章：java代码的注释怎么写 java如何注释代码
本文地址：http://csdahua.cn/article/hihhsp.html