java中的几种注释方式
首先我得说一下为啥要写注释。
注释仅仅是一段描述某个类或某个方法或某段代码的功能或作用,程序运行不会运行注释部分,并不会影响程序的运行。
既然注释对程序的执行没有任何影响,那么是否应该省略注释呢?
我认为不应该。因为代码未必是一直给一个人看。你终究会离开这个公司,如果不写注释,对于接手你代码的人理解起来就比较费劲。其次,人脑的记忆力是有限的,你不可能记住一个项目的所以实现细节。如果没有注释,当将来的某天在回头来看自己写过的代码,你依然会迷茫一会。所以注释是有必要。
J在ava中有三种注释,分别为:单行注释、多行注释和文档注释。
单行注释以“//”进行注释。通常只对当前行起注释作用。而多行注释则是以“/**/”囊括一段代码,被囊括的代码及被注释。文档注释则是以/***/加在类或方法前面,在生成API文档时辅助生成相关描述性信息。通常情况下,文档注释会配合一些注解来使用。
其中单行注释和多行注释是大多数编程语言都会支持的注释方式,而文档注释则是Java所特有。
总之,不论是哪种编程语言,注释都不可或缺。
使用eclipse如何自动生成注释
方法一:Eclipse中设置在创建新类时自动生成注释
windows–>preference
Java–>Code Style–>Code Templates
code–>new Java files
编辑它
123456789
${filecomment}${package_declaration}/*** @author 作者 E-mail:* @version 创建时间:${date} ${time}* 类说明*/${typecomment}${type_declaration}
方法二:
通过菜单 Window->Preference 打开参数设置面板,然后选择:
Java -> Code Style -> Code Templates
在右侧选择Comments,将其中的Files项,然后选右边的”Edit”,进入编辑模式:
进入编辑模式后就可以自定义注释了。另外可以插入一些变量,如年、日期等等。
最后,确保 Code -> New java files 中有:”${filecomment}”
当然,通过“导出”和“导入”功能,你可以把自己的模板导出来在其他机器上使用。
以上是文件注释,类中的方法自动添加注释类似,对应于Files下面的Types。
Eclipse快捷键:选中你的方法后alt+shift+J
关键词列表:
@author 作者名
@date 日期
@version 版本标识
@parameter 参数及其意义
eclipse怎样快速注释代码段
1、首先打开要编辑的java过程,打开java的文件:
2、选中要注释的代码段,然后点击鼠标右键选择Source,在选择AddBlockComment选项;或者直接按下快捷键“Crtl+Shift+/”也可以快速注释:
3、此时查看代码发现,刚才选择的部分已经被注释了。以上就是eclipse注释一段代码的操作方法: