重庆分公司,新征程启航
为企业提供网站建设、域名注册、服务器等服务
Window --Preferences-Java-Editor-Templates ,
在札达等地区,都构建了全面的区域性战略布局,加强发展的系统性、市场前瞻性、产品创新能力,以专注、极致的服务理念,为客户提供成都网站建设、成都网站设计 网站设计制作按需制作,公司网站建设,企业网站建设,品牌网站建设,全网营销推广,外贸网站制作,札达网站建设费用合理。
在这里new一个自己的插入注释的快捷方式名称,具体设置如下:
Name处输入 remark (任意你喜欢的名称)
context处选 java 后边勾选Automatically insert复选框
Description 这里可以任意输入描述
Pattern :(自定义格式)
/**
* @author ${user}
* @date : ${date} ${time}
*/
到这里全部设置完毕,下面 OK,找个java类,找个空白处测试一下, 输入remark(前面写的那个Name名称),
再alt+/ 应该按一下就能看到刚才的Description的内容。
写代码的时候,有时候,你需要写一些注释,把内容相互关联起来,方便自己或别人看的时候,可以直接找到你关联的代码类或者啥的。
这个时候,{@link}与@see,这2个javadoc注解就派上用场了,
不管他具体有什么功能,咱就只管一个,他可以链接代码,让注释看的更清楚易懂。方便你我他。
@see 标签允许用户引用其他类的文档。具体使用方式如下:
@see classname
@see fully-qualified-classname
@see fully-qualified-classname#方法名称
@see fully-qualified-classname#属性名称
我在使用的时候,发现这个只能单独一行顶头写,如果不顶头写就不管用了,没了链接的效果。
但是,{@link}这个却可以随便放。
具体使用方法和上面那个@see是一样的。
实际效果,看下面的图
eclipse设置创建一个java文件后自动加入注释的方法:
1、通过菜单 Window-Preference 打开参数设置面板,然后选择:
Java - Code Style - Code Templates
2、在右侧选择Comments,将其中的Files项,然后选右边的"Edit",进入编辑模式:
3、进入编辑模式后就可以自定义注释了。另外可以插入一些变量,如年、日期等等。
4、最后,确保 Code - New Java files 中有:"${filecomment}"
1、单行(single-line)--短注释://…… 单独行注释:在代码中单起一行注释, 注释前最好有一行空行,并与其后的代码具有一样的缩进层级。如果单行无法完成,则应采用块注释。 注释格式:/* 注释内容 */ 行头注释:在代码行的开头进行注释。主要为了使该行代码失去意义。 注释格式:// 注释内容 行尾注释:尾端(trailing)--极短的注释,在代码行的行尾进行注释。一般与代码行后空8(至少4)个格,所有注释必须对齐。 注释格式:代码 + 8(至少4)个空格 + // 注释内容
2、块(block)--块注释:/*……*/ 注释若干行,通常用于提供文件、方法、数据结构等的意义与用途的说明,或者算法的描述。一般位于一个文件或者一个方法的前面,起到引导的作用,也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成: /* * 注释内容 */
3、文档注释:/**……*/ 注释若干行,并写入javadoc文档。每个文档注释都会被置于注释定界符 /**......*/ ...
ctrl + / 是注释当前行的,不是多行的
单行注释:[ // ] ctrl + / 再次使用取消注释
多行注释:[ /* */ ] ctrl + shift + / ,ctrl + shift + \ 取消注释
doc注释: [ /** */ ] 输入/** 回车以后即可,适用于方法或者类的注释,这个注释非常好用
如果快捷键不能使用的话,请找目录“window”→“Preferences”→General→Keys
注释是用来给开发者或者是软件后续的维护者来看的。一般是用来描述这一段代码或者是程序做了些什么样的事情。实现了哪些功能,java里面注释代码,可以分为行注释和块注释,方法注释等。
行注释就是在需要注释的代码前加 //
块注释则是用 /* 和 */ 把文本段落框起来即可