`
ayaya
  • 浏览: 453834 次
  • 性别: Icon_minigender_1
  • 来自: 大连
社区版块
存档分类
最新评论

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

阅读更多
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
*/

当然添加完之后还需要手动添加其中的各项内容,如方法的功能和参数的含义等。
分享到:
评论

相关推荐

    Eclipse设置Java代码格式化(包含阿里格式化脚本).zip

    此外,还可以设置Eclipse在保存文件时自动格式化代码,这可以在`Preferences` -> `General` -> `Editors` -> `Text Editors` 中勾选`Insert spaces for tabs` 和 `Auto format on save`。 总的来说,通过合理配置...

    Eclipse注释模板和格式化模板.zip

    在Eclipse中,注释模板和格式化模板是两个非常实用的功能,可以帮助开发者快速编写规范、一致的代码。本资料包“Eclipse注释模板和格式化模板.zip”包含了配置这两个功能所需的文件。 首先,我们来看看`code...

    Eclipse 模板和格式化文件

    总结来说,Eclipse的模板和格式化功能是提升开发效率和代码质量的重要工具。通过定制模板,开发者可以快速编写常见代码结构;通过设置代码格式,可以保持代码的整洁和团队的一致性。了解并充分利用这些特性,将极大...

    eclipse代码格式化模板和注释格式化模板

    - 在新项目开始时,应尽早确定并共享代码格式化和注释模板,避免后期大规模的代码格式调整。 - 使用模板时,也要注意适度,避免过度自动化导致代码过于机械,丧失可读性。 总之,Eclipse的代码格式化模板和注释...

    eclipse代码格式化模板

    这样的模板通常存储为一个`.profile`文件,例如`formatter-profile.xml`,它可以被导入到Eclipse中,使得每次格式化代码时都遵循这些规则。 `formatter-profile.xml`文件是一个XML文档,包含了Eclipse代码格式化器...

    Eclipse/MyEclipse注释模板和格式化模板的使用

    总的来说,熟练掌握Eclipse/MyEclipse的注释模板和格式化模板,能极大提升编程效率,保持代码风格的一致性,也是专业开发人员的基本素养。合理利用这些功能,不仅能让代码更加规范,也能让团队协作更加顺畅。

    Eclipse 代码注释模板

    Eclipse是一款广泛使用的Java集成开发环境(IDE),它提供了丰富的功能来帮助开发者高效地编写、调试和管理代码。其中,代码注释模板是...因此,熟悉并掌握Eclipse的代码注释模板配置是每个Java开发者必备的技能之一。

    eclipse注释模板和格式化模板

    Eclipse是一款广泛使用的Java集成开发环境(IDE),它提供了丰富的功能...通过灵活运用Eclipse的注释模板和格式化模板,开发者可以极大地提高代码编写效率,同时保证代码风格的统一,提升代码的可读性和团队协作效率。

    java 格式代码模板

    总的来说,理解和使用`Java`代码格式模板和代码格式化器,是提高开发效率、保证代码质量的关键步骤。它们不仅可以帮助我们快速编写代码,还能确保代码的整洁和一致性,从而提升整个团队的开发体验。因此,无论是个人...

    eclispe代码格式化模板和注释格式化模板

    使用Eclipse的代码格式化和注释模板有以下几点好处: 1. **提高代码一致性**:每个团队成员都可以遵循相同的代码风格,避免了因个人习惯造成的差异。 2. **节省时间**:自动化的注释生成和代码格式化可以减少手动...

    设置Eclipse中的代码格式化模板及保存时自动格式化

    - 要使Eclipse在保存文件时自动格式化代码,转到`General` -> `Editors` -> `Text Editors`。 - 在右侧勾选`Save actions`,然后在`Format source code`选项中打勾。 6. **应用并分享设置**: - 完成所有设置后...

    Eclipse 格式化模板

    这实际上是Eclipse提供的一种定制化代码格式化的工具,允许开发者根据自己的编程习惯或项目需求设定代码缩进、空格、换行等格式规则,并将其保存为模板,方便日后统一应用。模板可以包含对类、方法、变量、注释等...

    代码模板和代码格式化

    同样,Java有Google的Java Format,Python有Black,它们都提供了命令行工具或者IDE插件,使得格式化代码变得简单。 代码格式化的优点在于,它强制了一种统一的代码风格,无论团队成员的个人偏好如何,都能保证代码...

    eclipse中格式代码配置

    6. **格式化代码**:最后,在编辑器中选中需要格式化的代码区域,使用快捷键`Ctrl + Shift + F`执行格式化操作。如果没有选中任何代码,则默认格式化整个文件。 #### 三、进阶配置与自动化 除了上述基本的格式化...

    Eclipse注释模板自定义

    总结,Eclipse的注释模板自定义功能允许开发者根据个人或团队的需求创建个性化的注释格式,提高代码的可读性和规范性。同时,通过`eclipse.ini`配置文件,可以全局管理版权信息,确保团队代码的统一性和合法性。熟练...

    Eclipse格式化插件(附文档)

    7. **遵循编码规范**:开发者可以自定义或选择已有的编码规范,如Google Java Style Guide或Oracle Java Conventions,让插件自动按照这些规范格式化代码。 接下来,我们来看看如何在Eclipse中启用和配置格式化插件...

    eclipse代码格式化

    Eclipse是一款广泛使用的Java集成开发环境(IDE),它提供了丰富的功能,包括...总之,Eclipse的代码格式化功能是提高开发效率和代码质量的重要工具,通过合理的配置和使用,可以显著提升开发体验和团队协作的效率。

    eclipsejava代码模板

    其中一个非常实用的功能就是代码模板和自动格式化,这正是"eclipsejava代码模板"这个主题所关注的核心内容。 **Eclipse 代码模板** 代码模板是Eclipse中的一个强大特性,它允许开发者预定义一系列代码片段,然后在...

Global site tag (gtag.js) - Google Analytics