正文
java代码写注释 java代码注释符号
提示：扫一扫查出行【扫一扫了解最新限行尾号】
复制提示
为什么要为程序添加注释，在java程序中如何为程序添加注释？
注释是用来给开发者或者是软件后续的维护者来看的。一般是用来描述这一段代码或者是程序做了些什么样的事情。实现了哪些功能，java里面注释代码，可以分为行注释和块注释，方法注释等。
行注释就是在需要注释的代码前加 //
块注释则是用 /* 和 */ 把文本段落框起来即可
相关问答
Q1: 如何写好java代码注释
写代码的时候，有时候，你需要写一些注释，把内容相互关联起来，方便自己或别人看的时候，可以直接找到你关联的代码类或者啥的。
这个时候，{@link}与@see，这2个javadoc注解就派上用场了，
不管他具体有什么功能，咱就只管一个，他可以链接代码，让注释看的更清楚易懂。方便你我他。
@see 标签允许用户引用其他类的文档。具体使用方式如下：
@see classname
@see fully-qualified-classname
@see fully-qualified-classname#方法名称
@see fully-qualified-classname#属性名称
我在使用的时候，发现这个只能单独一行顶头写，如果不顶头写就不管用了，没了链接的效果。
但是，{@link}这个却可以随便放。
具体使用方法和上面那个@see是一样的。
实际效果，看下面的图
Q2: 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用于提取源文件中的作者信息）
Q3: 给Java代码的的每一句做一个注释，很简单的
package com.test;//最好有包，包名可自定义
import java.awt.*;//导入java.awt包下所有的类
import java.awt.event.*;//导入java.awt.event包下所以的类
import javax.swing.*;//导入javax.swing包下所有的类
public class Test extends JFrame {
private JPanel panel;
private JLabel one, equ, result, img, end;
private JTextField input;
private JButton check;
private int first, second;
public Test() {
super("小程序查看器");// 调用JFrame的构造方法，名字是“小程序查看器”
one = new JLabel("小程序");// 创建名称为“小程序”的JLabel标签
one.setFont(new Font("宋体", Font.PLAIN, 15));// 设置JLabel控件的字体参数
makeRandom();// 生成随机数
equ = new JLabel(first + "+" + second + "=");// 创建算式
input = new JTextField(10);// 创建宽度是10的文字输入框
check = new JButton("检查");// 创建检查按钮
check.addActionListener(new ActionListener() {// 给检查按钮添加事件监听器
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();// 创建一个新的结果标签，赋值给result变量
img = new JLabel(new ImageIcon("1.jpg"));// 创建一个带图片的标签
panel = new JPanel(new FlowLayout(FlowLayout.CENTER, 5, 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));// 字体为宋体，普通格式，字号为15
end.setOpaque(true);// 透明效果
end.setBackground(Color.WHITE);// 背景白色
getContentPane().add(one, BorderLayout.NORTH);// 在上面添加小程序标签
getContentPane().add(panel, BorderLayout.CENTER);// 在中间添加panel
getContentPane().add(end, BorderLayout.SOUTH);// 在下面添加结束标签
setSize(300, 300);// 设置显示大小为300*300
setLocationRelativeTo(null);// 不偏移
setDefaultCloseOperation(3);// 默认关闭操作，点击关闭时候退出
setVisible(true);// 设置可见状态
}
/**
* 此方法描述的是：获取随机数
*/
public void makeRandom() {
first = (int) (Math.random() * 100 + 1);
second = (int) (Math.random() * 100 + 1);
}
/**
* 此方法描述的是：程序的主入口 main方法
*/
public static void main(String[] args) {
new Test();// 创建新的实例，调用无参数的构造方法
}
}
关于java代码写注释和java代码注释符号的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。
