java代码自注释,java开发中的注解自定义详解

eclipse怎么设置创建一个java文件后自动加入注释

eclipse设置创建一个java文件后自动加入注释的方法：

成都创新互联公司是一家专业提供攸县企业网站建设,专注与成都网站制作、成都网站设计、外贸营销网站建设、H5响应式网站、小程序制作等业务。10年已为攸县众多企业、政府机构等服务。创新互联专业网站设计公司优惠进行中。

1、通过菜单 Window-Preference 打开参数设置面板，然后选择：

Java - Code Style - Code  Templates

2、在右侧选择Comments,将其中的Files项，然后选右边的"Edit"，进入编辑模式：   

3、进入编辑模式后就可以自定义注释了。另外可以插入一些变量，如年、日期等等。

4、最后，确保 Code - New Java files 中有："${filecomment}"

什么是注释？如何在Java程序中加入注释？

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

Java中代码的注释有三种：

// 注释一行 

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

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

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

扩展资料

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

java中如何自动生成注释

你说的应该是生成javadoc吧?

最简单方式就是使用命令行, cd到你的项目源代码目录下, 输入如下指令:

javadoc -d docs -subpackages com.yourpackage

其中-d docs指定了生成的javadoc在相对目录docs下, -subpackages com.yourpackage指定了你要被生成javadoc的源代码包.

JAVADOC是官方提供的一种生成注释文档的工具, 他的用法如下:

用法: javadoc [options] [packagenames] [sourcefiles] [@files]

-overview file                 从 HTML 文件读取概览文档

-public                          仅显示 public 类和成员

-protected                       显示 protected/public 类和成员 (默认值)

-package                         显示 package/protected/public 类和成员

-private                         显示所有类和成员

-help                            显示命令行选项并退出

-doclet class                  通过替代 doclet 生成输出

-docletpath path               指定查找 doclet 类文件的位置

-sourcepath pathlist           指定查找源文件的位置

-classpath pathlist            指定查找用户类文件的位置

-cp pathlist                   指定查找用户类文件的位置

-exclude pkglist               指定要排除的程序包列表

-subpackages subpkglist        指定要递归加载的子程序包

-breakiterator                   计算带有 BreakIterator 的第一个语句

-bootclasspath pathlist        覆盖由引导类加载器所加载的

类文件的位置

-source release                提供与指定发行版的源兼容性

-extdirs dirlist               覆盖所安装扩展的位置

-verbose                         输出有关 Javadoc 正在执行的操作的信息

-locale name                   要使用的区域设置, 例如 en_US 或 en_US_WIN

-encoding name                 源文件编码名称

-quiet                           不显示状态消息

-Jflag                         直接将 flag 传递到运行时系统

-X                               输出非标准选项的提要

通过标准 doclet 提供:

-d directory                   输出文件的目标目录

-use                             创建类和程序包用法页面

-version                         包含 @version 段

-author                          包含 @author 段

-docfilessubdirs                 递归复制文档文件子目录

-splitindex                      将索引分为每个字母对应一个文件

-windowtitle text              文档的浏览器窗口标题

-doctitle html-code            包含概览页面的标题

-header html-code              包含每个页面的页眉文本

-footer html-code              包含每个页面的页脚文本

-top    html-code              包含每个页面的顶部文本

-bottom html-code              包含每个页面的底部文本

-link url                      创建指向位于 url 的 javadoc 输出的链接

-linkoffline url url2        利用位于 url2 的程序包列表链接至位于 url 的文档

-excludedocfilessubdir name1:.. 排除具有给定名称的所有文档文件子目录。

-group name p1:p2..        在概览页面中, 将指定的程序包分组

-nocomment                       不生成说明和标记, 只生成声明。

-nodeprecated                    不包含 @deprecated 信息

-noqualifier name1:name2:... 输出中不包括指定限定符的列表。

-nosince                         不包含 @since 信息

-notimestamp                     不包含隐藏时间戳

-nodeprecatedlist                不生成已过时的列表

-notree                          不生成类分层结构

-noindex                         不生成索引

-nohelp                          不生成帮助链接

-nonavbar                        不生成导航栏

-serialwarn                      生成有关 @serial 标记的警告

-tag name:locations:header 指定单个参数定制标记

-taglet                          要注册的 Taglet 的全限定名称

-tagletpath                      Taglet 的路径

-charset charset               用于跨平台查看生成的文档的字符集。

-helpfile file                 包含帮助链接所链接到的文件

-linksource                      以 HTML 格式生成源文件

-sourcetab tab length          指定源中每个制表符占据的空格数

-keywords                        使程序包, 类和成员信息附带 HTML 元标记

-stylesheetfile path           用于更改生成文档的样式的文件

-docencoding name              指定输出的字符编码

java 怎样给源代码添加注释

1、单行(single-line)--短注释：//……

单独行注释：在代码中单起一行注释，

注释前最好有一行空行，并与其后的代码具有一样的缩进层级。如果单行无法完成，则应采用块注释。

注释格式：/*

注释内容

*/

行头注释：在代码行的开头进行注释。主要为了使该行代码失去意义。

注释格式：//

注释内容

行尾注释：尾端(trailing)--极短的注释，在代码行的行尾进行注释。一般与代码行后空8（至少4）个格，所有注释必须对齐。

注释格式：代码

+

8（至少4）个空格

+

//

注释内容

2、块(block)--块注释：/*……*/

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

/*

*

注释内容

*/

3、文档注释：/**……*/

注释若干行，并写入javadoc文档。每个文档注释都会被置于注释定界符

/**......*/

...

java代码注释所有代码

好像和另外一个一样，贴一下：

import java.awt.*;

import java.awt.event.*;

import javax.swing.*;

public class GoodLucky extends JFrame implements ActionListener{

JTextField tf = new JTextField(); //实例化一个文本域

//设置两个按钮

JButton b1 = new JButton("开始");

JButton b2 = new JButton("停止");

boolean isGo = false;

//构造函数

public GoodLucky(){

b1.setActionCommand("start");//在开始按钮上设置一个动作监听 start

JPanel p = new JPanel(); //实例化一个可视化容器

//将两个按钮添加到可视化容器上面，用add方法

p.add(b1);

p.add(b2);

//在两个按钮上增加监听的属性,自动调用下面的监听处理方法actionPerformed(ActionEvent e)，如果要代码有更好的可读性，可用内部类实现动作

//监听处理。

b1.addActionListener(this);

b2.addActionListener(this);

//将停止按钮设置为不可编辑（即不可按的状态）

b2.setEnabled(false);

this.getContentPane().add(tf,"North"); //将上面的文本域放在面板的北方，也就是上面（上北下南左西右东）

this.getContentPane().add(p,"South"); //将可视化容器pannel放在南边，也就是下面

this.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); //设置用户在此窗体上发起 "close" 时默认执行的操作，参数EXIT_ON_CLOSE是使用 System exit 方法退出应用程序。仅在应用程序中使用

this.setSize(300,200); //设置面板大小，宽和高

this.setLocation(300,300); //设置面板刚开始的出现的位置

Cursor cu = new Cursor(Cursor.HAND_CURSOR); //用指定名称创建一个新的定制光标对象，参数表示手状光标类型

this.setCursor(cu); //为指定的光标设置光标图像，即设置光标图像为上面所创建的手状光标类型

this.setVisible(true); //将面板可视化设置为true，即可视，如果为false，即程序运行时面板会隐藏

tf.setText("welcome you! "); //设置面板的标题为欢迎

this.go(); //调用go方法

}

public void go(){

while(true){ //这里是死循环，也就是说用户不点击停止按钮的话他一直循环出现随机数，直到用户点击停止按钮循环才能推出，具体流程在actionPerformed方法中控制。

if(isGo == true){ //上面所定义的isGo的初始值为false，所以程序第一次到此会跳过

String s = ""; //设置空字符串

for(int j = 1; j = 7;j++){ //产生7个随机数

int i = (int)(Math.random() * 36) + 1;//每个随机数产生方式，这里定义灵活，可以自由定义随机数产生的方式

if(i 10){

s = s + " 0" + i; //如果产生的随机数小于10的话做处理：这里就牵扯到一个重要的概念，简单叙述一下：

/*

当一个字符串与一个整型数项相加的意思是连接，上面的s = s + " 0" + i的意思是字符串s链接0再连接整型i值，而不会导致0和整型的i相加，

产生的效果为s0i,由于s为空字符串（上面定义过的），所以当i小于零时，在个位数前面加上0，比如产生的随机数i为7的话，显示效果为 07.

*/

}else{

s = s + " " + i; //如果产生的随机数比10打的话，那么加上空格显示，即数字和数字之间有个空格

}

//以上循环循环七次，以保证能出现7个随机数

}

tf.setText(s); //将产生的随机数全部显示在文本域上，用文本域对象tf调用它的设置文本的方法setText(String)实现。

}

//以下为线程延迟

try{

Thread.sleep(10); //线程类同步方法sleep，睡眠方法，括号里的单位为ms。

}catch(java.lang.InterruptedException e){

e.printStackTrace(); //异常捕获，不用多说。

}

}

}

//以下是上面设置的事件监听的具体处理办法，即监听时间处理方法，自动调用

public void actionPerformed(ActionEvent e){ //传入一个动作事件的参数e

String s = e.getActionCommand(); //设置字符串s来存储获得动作监听，上面的start

/*

以下这个条件语句块的作用为：用户点击开始后（捕获start，用方法getActionCommand()），将命令触发设置为true，从而执行上面的go方法中的循环体（因为循环体中要求isGo参数为true,而初始为false）。

执行循环快产生随机数，并将开始按钮不可编辑化，而用户只可以使用停止按钮去停止。如果用户按下停止时，也就是没有传入参数“start”的时候，

执行else语句块中的语句，isGo设置为false，将不执行上面go中的循环语句块，从而停止产生随机数，并显示，并且把开始按钮设置为可用，而把

停止按钮设置为不可用，等待用户按下开始再去开始新一轮循环产生随机数。

*/

if(s.equals("start")){ //如果捕获到start，也就是用户触发了动作监听器，那么下面处理

isGo = true; //设置isGo为true

b1.setEnabled(false); //将开始按钮设置为不可用

b2.setEnabled(true); //将停止按钮设置为可用

}else{

isGo = false; //将isGo设置为false，isGo为循环标志位

b2.setEnabled(false); //设置停止按钮为不可用（注意看是b2,b2是停止按钮）

b1.setEnabled(true); //设置开始按钮为可用

}

}

public static void main(String[] args){

new GoodLucky(); //产生类的实例，执行方法

}

}

网站题目：java代码自注释,java开发中的注解自定义详解
分享网址：http://6mz.cn/article/heodjh.html