如何让Java代码有注释，java文档注释怎么注释

为什么要为程序添加注释,在java程序中如何为程序添加注释?

定义规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。（这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性）。

注释的作用程序中注释作用是为了方便人对代码理解和维护而引入，它对程序功能没有影响。程序基本逻辑结构在结构化程序中，程序基本逻辑结构可分为顺序、选择和重复三种，程序语言提供相应语句及语句组织方式表达这三种结构。

函数等的解释或提示，能提高程序代码的可读性。注释只是为了提高可读性，不会被计算机编译。注释通常会分为行注释和块注释。行注释：在符号后那一行不会被编译（显示）；块注释：被块注释符号中间的部分不会被编译。

相关问答

Q1: 如何在java程序中添加注释

1、单行(single-line)--短注释：//…… 单独行注释：在代码中单起一行注释， 注释前最好有一行空行，并与其后的代码具有一样的缩进层级。如果单行无法完成，则应采用块注释。

2、（1）首先编写.java文件 （2）在命令行中执行以下dos命令：javadoc *.java //根据相应的Java源代码及其说明语句生成HTML文档 //javadoc标记：是@开头的，对javadoc而言，特殊的标记。

3、通过菜单 Window-Preference 打开参数设置面板，然后选择：Java - Code Style - Code Templates 在右侧选择Comments，将其中的Files项，然后选右边的Edit，进入编辑模式：进入编辑模式后就可以自定义注释了。

4、（1）单行注释：以“ // ”开头后面接所要加的说明的内容。

5、// 注释一行 /* ... */ 注释若干行 /** ... */ 注释若干行，并写入 javadoc 文档 前两种比较容易理解，至于第三种，你学习Java看的api文档就是javadoc程序根据第三种的注释生成的。

6、首先准备好软件即eclipse和java，下载安装完成后打开eclipse。点击左上角的file 新建一个project。给project取一个名字，其他的选项都是默认然后点击finish。接下来是新建一个class。

Q2: 如何在Eclipse中如何自动添加注释和自定义注释

1、通过菜单 Window-Preference 打开参数设置面板，然后选择： Java - Code Style - Code Templates在右侧选择Comments，将其中的Files项，然后选右边的”Edit”，进入编辑模式：进入编辑模式后就可以自定义注释了。

2、方法使用Ctrl+Shift+C快捷键 在Eclipse中拖动鼠标，选中需要注释的代码。按住Ctrl+Shift+C快捷键，如图所示。会发现所选代码被//注释掉。当调试完后，可再次按住Ctrl+Shift+C快捷键打开注释。

3、Formatter设置 Eclipse工具栏上选择Window - Preferences - Java - Code Style - Formatter，进入如下界面：代码自动格式化配置。

4、可通过如下三种方法自动添加注释：（1）输入“/**”并回车。（2）用快捷键 Alt＋Shift+J（先选中某个方法、类名或变量名）。（3）在右键菜单中选择“Source Generate ElementComment”。

如何让Java代码有注释的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于java文档注释怎么注释、如何让Java代码有注释的信息别忘了在本站进行查找喔。