昨天把之前的想法和yj交流后,发现其中缺失代码格式化中很重要的一块,就是每个方法的注释。方法注释用于说明该方法的各项信息,比如创建人、创建日期、主要功能及输入输出的说明。另外还了解到规范化方法注释可以用于自动生成JavaDoc,看起来和Java帮助文档很类似的项目说明文档。
今天找到eclipse中设置方法注释模板并使用方法注释的方法。
设置方法注释模板:选择eclipse菜单栏中【窗口】下的【首选项】,展开左边树到Java->代码样式->代码模板,展开右边出现的对话框中的注释->方法,点击右边的【编辑】按钮。编辑其中的内容。也可以点击下面的【插入变量】按钮添加变量。例如:
/**
* @author ${user}
* 功能:
* ${tags}
*/
其中@author是JavaDoc的标示,带$符号的是变量。
使用时鼠标放置在需要添加注释的方法内部的任意位置。点击菜单栏中【源代码】下的【添加Javadoc注释】,或者使用快捷键Alt+Shift+J,则eclipse自动在该方法前面添加注释,例如public static void main(String[] args)生成如下注释:
/**
* @author hfm
* 功能:
* @param args
*/
当然添加完之后还需要手动添加其中的各项内容,如方法的功能和参数的含义等。
posted on 2005-05-09 10:46
lippea'blog 阅读(1801)
评论(0) 编辑 收藏