Java魔法堂:注释和注释模板 (转)

http://www.cnblogs.com/fsjohnhuang/p/3988883.html

一、注释                                  

  1. 注释类型

[a]. 单行注释

// 单行注释
String type = "单行注释";

[b]. 多行注释

/*
 * 多行注释
 */
String type = "多行注释";

[c]. 文档注释

/**
 * 文档注释
 */
public class Dummy{}

  2. 快捷键

[a]. 添加/取消单行注释: Ctrl+/

[b]. 添加类的文档注释: Ctrl+Shift+j

二、注释模板                                

作用:定义文件、类和方法等默认的注释格式,减少手工输入的工作量。

 1. 设置注释模板的入口:点击 Window->Preference->Java->Code Style->Code Template ,然后展开 Comments节点 。

  2. Comments节点 下的元素介绍:

File节点(文件注释标签)

/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* @author fsjohnhuang
* @date ${date} ${time}
* @version V1.0
*/

Types节点(类注释标签)

/**
* @ClassName: ${type_name}
* @Description: ${todo}(这里用一句话描述这个类的作用)
* @author fsjohnhuang
* @date ${date} ${time}
*
* ${tags}
*/

      Fields节点(字段注释标签)

/**
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/ 

Constructor节点(构造函数注释标签)

/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/

Method节点(方法注释标签)

按 Ctrl+C 复制代码

按 Ctrl+C 复制代码

Overriding Methods节点(覆盖方法注释标签)

/*
* Title: ${enclosing_method}
*Description:
* ${tags}
* ${see_to_overridden}
*/

 Delegate Methods节点(代理方法注释标签)

/**
* ${tags}
* ${see_to_target}
*/ 

   getter节点(getter方法注释标签)

/**
* @return ${bare_field_name}
*/

setter节点(setter方法注释标签)

/**
* @param ${param} 要设置的 ${bare_field_name}
*/

  3. 导入、导出注释模板

在 Window->Preference->Java->Code Style->Code Template 下可导入导出注释模板。

尊重原创,转载请注明来自:http://www.cnblogs.com/fsjohnhuang/p/3988883.html  ^_^肥仔John

时间: 2024-10-13 07:51:06

Java魔法堂:注释和注释模板 (转)的相关文章

Java魔法堂:String.format详解

Java魔法堂:String.format详解   目录     一.前言    二.重载方法     三.占位符     四.对字符.字符串进行格式化     五.对整数进行格式化     六.对浮点数进行格式化     七.对日期时间进行格式化     八.其他转换符  九.总结   参考 一.前言 String.format 作为文本处理工具,为我们提供强大而丰富的字符串格式化功能,为了不止步于简单调用 String.format("Hello %s", "John&q

Java魔法堂:String.format详解 (转载)

Java魔法堂:String.format详解   目录 一.前言 二.重载方法 三.占位符 四.对字符.字符串进行格式化 五.对整数进行格式化 六.对浮点数进行格式化 七.对日期时间进行格式化 八.其他转换符   九.总结   参考 一.前言 String.format 作为文本处理工具,为我们提供强大而丰富的字符串格式化功能,为了不止步于简单调用 String.format("Hello %s", "John"); ,下面将笔记整理并记录下来. 二.重载方法 /

Java魔法堂:类加载器入了个门

一.前言 <Java魔法堂:类加载机制入了个门>中提及整个类加载流程中只有加载阶段作为码农的我们可以入手干预,其余均由JVM处理.本文将记录加载阶段的核心组件——类加载器的相关信息,以便日后查阅.若有纰漏请大家指正,谢谢. 注意:以下内容基于JDK7和HotSpot VM. 二.类加载器种类及其关系 从上图可知Java主要有4种类加载器 1. Bootstrap ClassLoader(引导类加载器):作为JVM的一部分无法在应用程序中直接引用,由C/C++实现(其他JVM可能通过Java来实

【转】Java魔法堂:String.format详解

Java魔法堂:String.format详解   目录     一.前言    二.重载方法     三.占位符     四.对字符.字符串进行格式化     五.对整数进行格式化     六.对浮点数进行格式化     七.对日期时间进行格式化     八.其他转换符  九.总结   参考 一.前言 String.format 作为文本处理工具,为我们提供强大而丰富的字符串格式化功能,为了不止步于简单调用 String.format("Hello %s", "John&q

Java魔法堂:深入正则表达式API

目录 一.前言 二.正则表达式的使用诉求 三.java.util.regex包 四.java.lang.String实例 五.最短路径实现诉求 六.Java支持的正则表达式功能语法 七.总结 八.参考 一.前言   正则表达式作为文本处理的利器,早已成为各大语言的必要装备,但各语言对其的实现程度(功能语法支持程度)和API设计均有所差异,本篇将目光投向java原生类库中提供的正则表达式API-- java.util.regex包 和 java.lang.String实例方法 ,和所支持的功能语法

Java魔法堂:注释和注释模板

一.注释   1. 注释类型 [a]. 单行注释 // 单行注释 String type = "单行注释"; [b]. 多行注释 /* * 多行注释 */ String type = "多行注释"; [c]. 文档注释 /** * 文档注释 */ public class Dummy{}   2. 快捷键 [a]. 添加/取消单行注释: Ctrl+/ [b]. 添加类的文档注释: Ctrl+Shift+j 二.注释模板   作用:定义文件.类和方法等默认的注释格式,

.Net魔法堂:提取注释生成API文档

一.前言 在多人协作的项目中,除了良好的代码规范外,完整的API文档也相当重要.通过文档我们快速了解系统各模块的实际接口,及其使用场景.使用示例,一定程度上降低沟通成本,和减少后期维护中知识遗失等风险. 对于.Net,我们可以直接将类.方法等的注释直接转为API文档,极大地减少文档维护的工作量,同时也能反向提高大家的注释质量. 下面我们使用.Net唯一的注释生成API文档工具——Sandcastle和Sandcastle Help File Builder来实现API文档自动化吧! 二.工具 S

JAVA魔法堂:读取.properties配置文件

一.前言 Java工程中想log4j.数据库连接等配置信息一般都写在.properties文件中,那么如何读取这些配置信息呢?下面把相关方法记录下来供以后查阅. 二..properties文件 配置文件的一种,内容以键值对的形式存在,且每个键值对独占一行.#号作为行注释的起始标志,中文注释会自动进行unicode编码.示例: # ip and port of server socket ip=127.0.0.1 port=9999 # error message msg=I'm sorry, b

Java魔法堂:解读基于Type Erasure的泛型

一.前言 还记得JDK1.4时遍历列表的辛酸吗?我可是记忆犹新啊,那时因项目需求我从C#转身到Java的怀抱,然后因JDK1.4少了泛型这样语法糖(还有自动装箱.拆箱),让我受尽苦头啊,不过也反映自己的水平还有待提高,呵呵.JDK1.5引入了泛型.自动装箱拆箱等特性,C#到Java的过渡就流畅了不少.下面我们先重温两者非泛型和泛型的区别吧! // 非泛型遍历列表 List lst = new ArrayList(); lst.add(1); lst.add(3); int sum = 0; fo