「java代码文档注释模板」Java注释语句

今天给各位分享java代码文档注释模板的知识，其中也会对Java注释语句进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！

本文目录一览：

• 1、如何在eclipse 中设置自动添加Javadoc注释
• 2、java 怎样给源代码添加注释
• 3、eclipse怎么设置创建一个java文件后自动加入注释
• 4、什么是注释？如何在Java程序中加入注释？
• 5、如何在Eclipse中如何自动添加注释和自定义注释风格

如何在eclipse 中设置自动添加Javadoc注释

在eclipse 中设置自动添加Javadoc注释：

1、打来eclipse：首先打开eclipse，然后随意打开一个java类文件，最好找一个没有注释的类，方便实践一下；

2、打开perference：在已经打来的eclipse中，点击顶部工具栏中的window目录下的perference按钮，进入perference窗体；

3、找到Code Templates：在perference窗体的左边栏中，输入Code Templates ,按回车键回车，就能快速定位到Code Templates；

4、设置风格和进行勾选：

在Code Template 中找到comment目录，该目录下就是有关注释的相关代码风格设置，这里有各种类型，字段，类型，构造方法以及继承的方法，这里面已经是系统默认的注释，可以点击edit按钮自行定义，现在重要的是点击下面的勾选按钮进行勾选，然后保存设置；

5、选中方法体测试：

在eclipse代码编辑区域，选中一方法，该方法实现了某接口定义的方法，像图中所示选中它，按快捷键Shift+Alt+J;

6、查看效果：

经过上面的快捷键操作，就能看到，Javadoc注释的代码已经自动添加到编辑方法体上面，方便我们以后开发的阅读，提高效率。

java 怎样给源代码添加注释

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

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

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

注释格式：/*

注释内容

*/

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

注释格式：//

注释内容

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

注释格式：代码

+

8（至少4）个空格

+

//

注释内容

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

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

/*

*

注释内容

*/

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

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

/**......*/

...

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

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

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程序根据第三种的注释生成的。

扩展资料

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

如何在Eclipse中如何自动添加注释和自定义注释风格

在Eclipse中自动添加注释和自定义注释风格的方法：

1、Formatter设置

Eclipse工具栏上选择Window - Preferences - Java - Code Style - Formatter，进入如下界面：

2、代码自动格式化配置。点击“Edit...”按钮，进入如下Formatter配置界面：

上面红色框标记的选项卡中，是所有可以配置的选项。下面对每个选项卡大致可以设置的内容进行简单介绍：

Indentation缩进

    Tab policy指定是否可以使用Tab键，有Spaces only（只支持空格键），Tabs only（只支持Tab键）和Mixed（同时支持空格键和Tab键）。为了保证代码在不同IDE和运行环境的兼容性和一致性，强烈建议选择Spaces only。Indentation size指定每次缩进多少个空格，Tab size指定一个Tab键相当于多少个空格。在Spaces only情况下，按Tab键，会自动转化成对应数量的空格。

Align fields in columns指定属性是否按列对齐。

Indent框中指定Java Code中常见元素是否缩进。

Braces大括号

Braces positions指定Java Code中一些元素的大括号的位置，大概有Same line（同行），Next line（下行），Next line indented（下行缩进）等选择。

White Space空格

  控制在Declarations、Control statements、Expressions、Arrays和Parameterized types这几类元素中的相应位置插入空格。

Blank Lines空行

控制class文件中元素之间空行的数量，基本上采用默认值。

New Lines新行

控制class文件中元素是否插入新的一行。

Control Statements控制语句

控制像if和else，do和while，以及try、catch和finally成套的控制关键字的位置。

Line Wrapping换行

Maximum line width控制每行的最大字符数。

Default indentation for wrapped lines指定换行时缩进多少个空格。

还可以详细控制class各元素是否换行。

3、点击“Configure...”按钮对额外操作进行设置，设置界面如下：

Comments注释

对各种注释（包括文件头注释，行注释，块注释，Javadoc注释）进行格式设置。

关于java代码文档注释模板和Java注释语句的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。