Java开发中版权声明及类注释的自动完成

Java项目开发中,不可避免需要在编码文件上面加上一些版权声明或者类注释,如果文件很多,手工去添加或者修改,真的很累。可以利用工具满足我们的要求。
我是用Eclipse的,所以也就说明一下Eclipse下是怎么做的。
一、版权声明可以使用Jautodoc
将jautodoc的plugin和feature目录对应copy到eclipse目录中,并且带-clean参数重新启动一次eclipse(以后不再需要该参数)
到eclipse的window-reference菜单中,java-jautodoc,configure project specific settings中,选择add file header,并点【edit】按钮,输入版权信息,保存。
以后要添加版权时,按alt+shift+J,就可以了。
类似的版权信息如下:

/*******************************************************************************
 *    系统名称   : 某某工作管理系统
 *    客户      : 某某软件
 *    文件名    : ${file_name}
 *              (C) Copyright xxxx Corporation ${year}
 *               All Rights Reserved.
 * *****************************************************************************
 *    注意: 本内容仅限于某某软件公司内部使用,禁止转发
 *****************************************************************************
*/

 

其中,${file_name}和${year}是内置的变量,在编辑模板的时候,输入$之后,会有很多类似的变量提示显示出来。有兴趣可以看看。

二、类注释,可以直接使用eclipse的code style功能。
window-reference-java-code style-code templates-comments,选中type,然后点击【edit】按钮,输入类注释信息,保存。
以后要添加版权时,按Ctrl+alt+J,就可以了。
类似的类注释如下:

/**
 * <PRE>
 * 作用
 *       XXXX
 * 限制
 *       无。
 * 注意事项
 *       无。
 * 修改历史
 * -----------------------------------------------------------------------------
 *         VERSION       DATE            BY       CHANGE/COMMENT
 * -----------------------------------------------------------------------------
 *          1.0          ${date}     wutiansheng         create
 * -----------------------------------------------------------------------------
 * </PRE>
 
*/

 

 同样,这里的${date}也是预定义的变量 

posted on 2008-02-15 15:39  Squall  阅读(4070)  评论(0编辑  收藏  举报

导航