为什么要为程序添加注释，在java程序中如何为程序添加注释？

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

我们提供的服务有：网站设计制作、做网站、微信公众号开发、网站优化、网站认证、商城ssl等。为1000+企事业单位解决了网站和推广的问题。提供周到的售前咨询和贴心的售后服务，是有科学管理、有技术的商城网站制作公司

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

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

如何写好java代码注释

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

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

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

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

@see classname

@see fully-qualified-classname

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

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

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

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

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

实际效果，看下面的图

如何在java程序中添加注释

1、单行(single-line)--短注释：//…… 单独行注释：在代码中单起一行注释， 注释前最好有一行空行，并与其后的代码具有一样的缩进层级。如果单行无法完成，则应采用块注释。 注释格式：/* 注释内容 */ 行头注释：在代码行的开头进行注释。主要为了使该行代码失去意义。 注释格式：// 注释内容 行尾注释：尾端(trailing)--极短的注释，在代码行的行尾进行注释。一般与代码行后空8（至少4）个格，所有注释必须对齐。 注释格式：代码 + 8（至少4）个空格 + // 注释内容

2、块(block)--块注释：/*……*/ 注释若干行，通常用于提供文件、方法、数据结构等的意义与用途的说明，或者算法的描述。一般位于一个文件或者一个方法的前面，起到引导的作用，也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成： /* * 注释内容 */

3、文档注释：/**……*/ 注释若干行，并写入javadoc文档。每个文档注释都会被置于注释定界符 /**......*/ ...

给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代码注释怎么做的
网站路径：http://pwwzsj.com/article/ddcchgp.html