代码模板插件,用于针对项目中重复的东西,进行定制模板。之后在开发新功能的时候,可以不用一个一个创建包和类,直接通过模板生成所有重复的内容。 使用代码模板的好处:
- 可以减少重复操作,节省时间;
- 使用模板进行开发,一定程度上可以规范所有项目组成员的代码,同时让所有人参考模板的编程风格;
- 新人培养不会被老代码影响,新人在学习的时候,先弄清楚每个模板的内容,方便理解开发功能所必须的东西;
- 从gitlab中下载codeTemplate插件和example_template.xml配置文件;
- 开启IDEA,安装插件;
- 进入
设置 --> other settings --> CodeTemplates
,在Config File中选择刚刚下载的配置文件。(此处可以不使用example_template.xml,而自己新创建一个xml文件) - 在Author中输入作者
到这里就完成了插件的安装。项目组成员之间分享已经做好的模板,可以彼此共享xml文件,或是将xml文件中的template标签内容粘贴到自己的配置文件中。
在CodeTemplates中编辑模板。以下内容都只介绍创建,编辑功能和创建类似。
- 点击
create
按钮打开创建模板界面; - 输入模板名称和描述;
- 下方展示了模板的结构树,在这个结构树中编辑模板的内容;
注:TemplateRoot节点只是用于占位,在实际使用中并不会出现。
选中需要添加子包的节点,点击AddPackage
按钮打开包编辑界面,在PackageName中输入包名,点击ok即可添加包。
- 选中要添加类的包,点击
AddClass
按钮,打开类文件编辑界面; - 输入节点名称,用于在模板结构树中展示。;
- 输入类名,可以携带参数;
- 在ClassContent中输入类的内容。下方列举了模板中支持的参数和说明,这些参数可以用在类名,类的内容中。
补充说明:
- 在编辑类内容的时候,推荐在其他文本编辑器中编辑好,再粘贴过来,目前使用的文本域组件不是很好用,也没有代码提示和补全功能。暂时没考虑优化这部分内容。
- 和新建类一样,在需要增加新模块的包上点击右键,选择use template;
- 在窗口中输入模块名,下方会自动生成驼峰风格名称和下划线分割风格名称。后面两种风格名称可以进行编辑,编辑后不会再自动生成;
- 选择想要使用的模板;
- 点击OK按钮,即可完成所有内容的创建。