Eclipse怎么注释代码

Posted 2023-03-28

参考技术A

在进行程序调试时，可能需要注释掉大片的程序代码，以缩小Bug出现的范围，从而尽快锁定错误原因。那么使用Eclipse如何快速注释程序代码呢？下面就讲解3种常用方法。

法一：使用Ctrl+/快捷键

第1步：在Eclipse中拖动鼠标，选中需要注释的代码，通常为连续多行代码。

第2步：按住Ctrl+/快捷键

第3步：会发现所选代码被“//”注释掉。当调试完后，可再次按住Ctrl+/快捷键打开注释。

方法二：使用Ctrl+Shift+C快捷键

第1步：在Eclipse中拖动鼠标，选中需要注释的代码。

第2步：按住Ctrl+Shift+C快捷键

第3步：会发现所选代码被“//”注释掉。当调试完后，可再次按住Ctrl+Shift+C快捷键打开注释。

方法三：使用Ctrl+Shift+/快捷键

第1步：在Eclipse中拖动鼠标，选中需要注释的代码。

第2步：按住Ctrl+Shift+/快捷键。

第3步：会发现所选代码被“/*  */”注释掉。

第4步：当调试完后，可按住Ctrl+Shift+\\快捷键打开注释。

的上面自动添加代码注释，Eclipse中该怎么设置

1.先看默认状态的吧，新建类文件时，是不生成注释的

2.在windows-->preferenceJava-->Code Style-->Code Templatescode-->new Java file编辑文件为7的样式，（为了方便起见，中间分布截图说明，熟悉的朋友直接跳到7）

3.对于中文版本

窗口-->首选项

java-->代码样式-->代码模板

代码-->新的java文件

4.菜单栏，窗口——首选项

5.找到java选项-->代码样式

6.注释-->新生成的java文件

7.直接编辑配置文件在配置文件中间添加注释代码，这部分可以自定义，参考如下，关键字解释见后文10

$filecomment$package_declaration/** * @author  作者 E-mail: * @date 创建时间：$date $time * @version 1.0 * @parameter  * @since  * @return  */$typecomment$type_declaration

8.现在新建文件将自动生成注释

补充说明;

也许你看到我们在写注释文件时用到了很多关键字，那么这里我们就了解一下Javadoc

Javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了

关键词列表：

@author 作者名

@date 日期

@version 版本标识

@parameter 参数及其意义

@since 最早使用该方法/类/接口的JDK版本

@return 返回值

@throws 异常类及抛出条件

@deprecated 引起不推荐使用的警告

@see reference 查看引用

@override 重写

更多Javadoc用法可以访问：百度百科、官方文档。

感谢阅读！

参考技术A

分两种情况的：

如果是javadoc的注释：可以通过 alt+shift+ j

如果是 lisence：可以同个 code template实现

自定义注释风格

Window->Preference 打开参数设置面板，然后选择：Java -> Code Style -> CodeTemplates


可以看到Comments下面一系列可以注释的Java代码组成部分（对文件、变量、方法、构造方法、重载函数等等），比如我想定制Java文件的注释风格，那么在右侧选择Comments中的File项，点击Edit，进入编辑模式，这样就可以自定义注释了。其中可以插入一些变量，如日期、文件名、作者等等。