昨天把之前的x?/SPAN>yj交流后，发现其中~失代码格式化中很重要的一块，是每个Ҏ的注释。方法注释用于说明该Ҏ的各信息，比如创徏人、创建日期、主要功能及输入输出的说明。另外还了解到规范化Ҏ注释可以用于自动生成JavaDocQ看h?/SPAN>Java帮助文档很类似的目说明文档?/SPAN>
今天扑ֈeclipse中设|方法注释模板ƈ使用Ҏ注释的方法?/SPAN>
讄Ҏ注释模板Q选择eclipse菜单栏中【窗口】下的【首选项】，展开左边树到Java->代码样式->代码模板Q展开双出现的对话框中的注释->ҎQ点d边的【编辑】按钮。编辑其中的内容。也可以点击下面的【插入变量】按钮添加变量。例如：
/**
* @author ${user}
* 功能Q?/SPAN>
* ${tags}
*/
其中@author?/SPAN>JavaDoc的标C，?/SPAN>$W号的是变量?/SPAN>
使用旉标放|在需要添加注释的Ҏ内部的Q意位|。点击菜单栏?SPAN style="COLOR: black">【源代码】下的【添?/SPAN>Javadoc注释】，或者用快捷键Alt+Shift+JQ则eclipse自动在该Ҏ前面d注释Q例?/SPAN>public static void main(String[] args)生成如下注释Q?/SPAN>
/**
* @author hfm
* 功能Q?/SPAN>
* @param args
*/
当然d完之后还需要手动添加其中的各项内容Q如Ҏ的功能和参数的含义等?/SPAN>
lippea'blog 2005-05-09 10:46 发表评论
]]>Eclipse有内|的代码格式化程序和模板Q也可以创徏自己的模板：
在菜单栏中选中『窗口?SPAN lang=EN-US>-〉『首选项』。在出现的对话框的左Ҏ中展开『Java』下的『代码样式』。其中有两项Q一Ҏ『代码格式化E序』，另一Ҏ『代码模ѝ。主要的是设|『代码格式化E序』，『代码模ѝ中讄的是自动生成的代码的格式Q比如setter和getterҎ的代码及相关注释??xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" />
讄『代码格式化E序』：Eclipse内置的模板不能导出，需要新Z个。输入模板名Uͼq择初始化设|的文g。这部分主要是设|格式化后代码的格式Q包括羃q、空行、花括弧{等内容。具体的东西按照自q爱好Q自己慢慢确定吧。然后点d出，存成.xml文g?o:p>
讄『代码模ѝ没有什么，主要是设|自动生成的一些方法等的注释格式，如getter/setterҎ的注释。里面可以包括一些变量，可以生成时自动填充相应内容，如姓名，参数名称{。设|完毕后Q点d部导出，存成.xml文g?o:p>
用的时候当然是分别点击导入按钮Q选择正确的配|文件。选中菜单栏中『源代码』下的格式化Q或者用快h?SPAN lang=EN-US>ctrl+shift+f对代码进行格式化。OK!
lippea'blog 2005-04-30 18:10 发表评论
]]>