怎样做java代码的注释 怎样做java代码的注释文件
给Java代码的的每一句做一个注释，很简单的
import java.awt.*;
创新互联提供成都网站建设、成都网站设计、网页设计，高端网站设计，广告投放等致力于企业网站建设与公司网站制作，十年的网站开发和建站经验,助力企业信息化建设，成功案例突破超过千家,是您实现网站建设的好选择.
import javax.swing.*;
import java.awt.event.*;
public class Test extends JFrame{
private JPanel panel; 定义容器
private JLabel one,equ,result,img,end; 定义标签
private JTextField input; 定义text框
private JButton check; 定义按钮
private int first, second; 定义int变量
public Test(){
super("小程序查看器"); 初始化 jframe的名称
one = new JLabel("小程序");初始化 标签的名称
one.setFont(new Font("宋体", Font.PLAIN, 15)); 设置字体
makeRandom(); 调用方法makeRandom
equ = new JLabel(first + "+" + second + "="); 设置equ标签的内容，内容为2个随机数相加的等式
input = new JTextField(10); 初始化输入框。
check = new JButton("检查"); 初始化按钮
check.addActionListener(new ActionListener(){ 给按钮添加点击事件，如果input中的值为first和second的和，result中显示you are right!，否则显示you are wrong!
public void actionPerformed(ActionEvent e){
int r = Integer.parseInt(input.getText());
if(first+second == r){
result.setText("you are right!");
}
else{
result.setText("you are wrong!");
}
}
});
result = new JLabel();
img = new JLabel(new ImageIcon("1.jpg"));
初始化容器，把元素都添加到容器
panel = new JPanel(new FlowLayout(FlowLayout.CENTER, 5, 5));
panel.add(equ);
panel.add(input);
panel.add(check);
panel.add(result);
panel.add(img);
设置标签的文字及样式等
end = new JLabel("小程序已启动。");
end.setFont(new Font("宋体", Font.PLAIN, 15));
end.setOpaque(true);
end.setBackground(Color.WHITE);
将不同的元素放到布局中的不同位置
getContentPane().add(one, BorderLayout.NORTH);
getContentPane().add(panel, BorderLayout.CENTER);
getContentPane().add(end, BorderLayout.SOUTH);
//设置jframe的大小及常规属性
setSize(300, 300);
setLocationRelativeTo(null);
setDefaultCloseOperation(3); 用于关闭
setVisible(true); 设置可见
}
给first和second初始化的函数
public void makeRandom(){
first = (int)(Math.random() * 100 + 1);
second = (int)(Math.random() * 100 + 1);
}
调用Test
public static void main (String[] args) {
new Test();
}
}
如何写好java代码注释
写代码的时候，有时候，你需要写一些注释，把内容相互关联起来，方便自己或别人看的时候，可以直接找到你关联的代码类或者啥的。
这个时候，{@link}与@see，这2个javadoc注解就派上用场了，
不管他具体有什么功能，咱就只管一个，他可以链接代码，让注释看的更清楚易懂。方便你我他。
@see 标签允许用户引用其他类的文档。具体使用方式如下：
@see classname
@see fully-qualified-classname
@see fully-qualified-classname#方法名称
@see fully-qualified-classname#属性名称
我在使用的时候，发现这个只能单独一行顶头写，如果不顶头写就不管用了，没了链接的效果。
但是，{@link}这个却可以随便放。
具体使用方法和上面那个@see是一样的。
实际效果，看下面的图
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程序中如何为程序添加注释？
注释是用来给开发者或者是软件后续的维护者来看的。一般是用来描述这一段代码或者是程序做了些什么样的事情。实现了哪些功能，java里面注释代码，可以分为行注释和块注释，方法注释等。
行注释就是在需要注释的代码前加 //
块注释则是用 /* 和 */ 把文本段落框起来即可
java 怎样给源代码添加注释
1、单行(single-line)--短注释：//……
单独行注释：在代码中单起一行注释，
注释前最好有一行空行，并与其后的代码具有一样的缩进层级。如果单行无法完成，则应采用块注释。
注释格式：/*
注释内容
*/
行头注释：在代码行的开头进行注释。主要为了使该行代码失去意义。
注释格式：//
注释内容
行尾注释：尾端(trailing)--极短的注释，在代码行的行尾进行注释。一般与代码行后空8（至少4）个格，所有注释必须对齐。
注释格式：代码
+
8（至少4）个空格
+
//
注释内容
2、块(block)--块注释：/*……*/
注释若干行，通常用于提供文件、方法、数据结构等的意义与用途的说明，或者算法的描述。一般位于一个文件或者一个方法的前面，起到引导的作用，也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成：
/*
*
注释内容
*/
3、文档注释：/**……*/
注释若干行，并写入javadoc文档。每个文档注释都会被置于注释定界符
/**......*/
...
可以帮我把一些JAVA代码加注释吗？ 方便我可以看得懂，理解的到，谢谢了。
java代码注释快捷键：ctrl+shift+/
首先熟悉一下html、css、js的注释的写法：
1、HTML注释语法：
!--注释的内容--
2、css注释语法
/* 注释内容 */
/* ----------文字样式开始---------- */
3、javaScript注释
//注释内容
/*注释内容*/
接下来是对注释在这几种代码中使用的位置，如何写注释进行总结一下。（根据个人的习惯可能不一样）
当前文章：怎样做java代码的注释 怎样做java代码的注释文件
标题URL：http://mswzjz.cn/article/hijhds.html