使用Eclipse创建模板并格式化代码

浏览数：16 / 时间：2015年06月20日

eclipse设置方式：
window-preferences-->java-code Style-formatter
在编写完代码后使用代码格式化程序对代码进行格式化，有利于版本冲突时进行对比和文件合并。想到当前代码编写格式多少有些太个性化，如果可以创建一份代码模板，将之导入到所有人的工具中，然后所有的代码在编写后都进行格式化，则避免了代码格式太混乱的情况，有利于大家阅读代码。
Eclipse有内置的代码格式化程序和模板，也可以创建自己的模板：
在菜单栏中选中『窗口』-〉『首选项』。在出现的对话框的左边树中展开『Java』下的『代码样式』。其中有两项，一项是『代码格式化程序』，另一项是『代码模板』。主要的是设置『代码格式化程序』，『代码模板』中设置的是自动生成的代码的格式，比如setter和getter方法的代码及相关注释。
设置『代码格式化程序』：Eclipse内置的模板不能导出，需要新建一个。输入模板名称，并选择初始化设置的文件。这部分主要是设置格式化后代码的格式，包括缩进、空行、花括弧等等内容。具体的东西就按照自己的爱好，自己慢慢确定吧。然后点击导出，存成.xml文件。
设置『代码模板』没有什么，主要是设置自动生成的一些方法等的注释格式，如getter/setter方法的注释。里面可以包括一些变量，可以生成时自动填充相应内容，如姓名，参数名称等。设置完毕后，点击全部导出，存成.xml文件。
用的时候当然是分别点击导入按钮，选择正确的配置文件。选中菜单栏中『源代码』下的格式化，或者使用快捷方式ctrl shift f对代码进行格式化。OK!
方法注释用于说明该方法的各项信息，比如创建人、创建日期、主要功能及输入输出的说明。另外还了解到规范化方法注释可以用于自动生成JavaDoc，看起来和Java帮助文档很类似的项目说明文档。
今天找到eclipse中设置方法注释模板并使用方法注释的方法。
设置方法注释模板：选择eclipse菜单栏中【窗口】下的【首选项】，展开左边树到Java->代码样式->代码模板，展开右边出现的对话框中的注释->方法，点击右边的【编辑】按钮。编辑其中的内容。也可以点击下面的【插入变量】按钮添加变量。例如：
/**
*@author${user}
*功能：
*${tags}
*/
其中@author是JavaDoc的标示，带$符号的是变量。
使用时鼠标放置在需要添加注释的方法内部的任意位置。点击菜单栏中【源代码】下的【添加Javadoc注释】，或者使用快捷键Alt Shift J，则eclipse自动在该方法前面添加注释，例如public static void main(String[]args)生成如下注释：
/**
* @authorhfm
*功能：
* @param args
*/
当然添加完之后还需要手动添加其中的各项内容，如方法的功能和参数的含义等。