且构网

分享程序员开发的那些事...
且构网 - 分享程序员编程开发的那些事

Eclipse中对javadoc注释的相关配置

更新时间:2022-08-16 23:13:36

Eclipsejavadoc注释模板配置位于:windowspreferencesjavacode stylecode templates,展开右侧窗口中的“comments”选项,对各子项目模板进行配置,如下图所示。

Eclipse中对javadoc注释的相关配置

图-1.  Eclipsejavadoc注释模板配置

Eclipse增加javadoc注释的快捷键配置位于:windowspreferenceskeys,在右侧查找“Add Javadoc Comment”,选中后在下部“Bindding”输入框内绑定快捷键。如下图绑定的快捷键是“Alt + W”。

Eclipse中对javadoc注释的相关配置

图-2.  Eclipse增加javadoc注释的快捷键配置

Eclipse中查看javadoc的方式有两种。

1、鼠标悬停在某个元素(类名,方法名,变量名)上,如果元素有对应的javadocEclipse将以悬浮框的形式进行提示。

2、通过windowsshow view打开javadoc视图。对鼠标选定的元素,如果元素有对应的javadocEclipse将在javadoc视图中进行提示。

================================
附上一套我惯用的javadoc模板
类文件

/**

 * @author: (个人签名)

 * @date: ${date}-${time}

 */

/**

 * @author (个人签名)

 * @since ${date}

 * @category TODO:

 * ${tags}

 */

字段

/**

 * @author Severus Lynn

 * @since ${date}

 * @category TODO:

 */

构造方法

/**

 * @author Severus Lynn

 * @since ${date}

 * @category

 * ${tags}

 */

普通方法

/**

 * @author Severus Lynn

 * @since ${date}

 * @category TODO:

 * @throws 

 * ${tags}

 * ${return_type}

 */

覆盖(接口或父类的)方法

/**

 * @author Severus Lyyn

 * @since ${date}

 * @category TODO:

 * @throws 

 * ${see_to_overridden}

 * 

 */

委托方法

/**

 * ${tags}

 * ${see_to_target}

 */

getter方法

/**

 * @return the ${bare_field_name}

 */

setter方法

/**

 * @param ${param} the ${bare_field_name} to set

 */



本文转自 斯然在天边 51CTO博客,原文链接:http://blog.51cto.com/winters1224/835988,如需转载请自行联系原作者