CodeStyle環境设置检查使用手册.docx

CodeStyle环境设置/检查/使用手册?2011-04-05 14:26:48|??分类： /haizai219@126/blog/ \l m=0t=1c=fks_080065084085084068082082074071080082080065081083083 \o J2SEJ2SE |??标签：/haizai219@126/blog/ \l m=0t=3c=checkstylecheckstyle?/haizai219@126/blog/ \l m=0t=3c=codestylecodestyle?/haizai219@126/blog/ \l m=0t=3c=eclipseeclipse?/haizai219@126/blog/ \l m=0t=3c=profileprofile?/haizai219@126/blog/ \l m=0t=3c=代码代码 |字号大中小?订阅 序言前提本文面向软件开发人员介绍Eclipse中CodeStyle的环境设置和使用方法，以及如何对CodeStyle做检查。开发人员需要了解一些常见的软件编码规范（如Sun的/code/java_code_conventions.htmlJava语言编码规范和Eclipse的编码规范）和Eclipse相关知识。范围 本文将讲述以下内容：l???????? Eclipse中CodeStyle的环境设置lCodeStyle的使用方法l???????? Eclipse下CheckStyle的安装及设置l使用CheckStyle检查CodeStyle 概述CodeStyle Eclipse中的CodeStyle为软件编码提供了极大的方便。CodeStyle一般有3个功能：l???????? Formatter，格式化代码为有序的格式，形成良好代码风格；l???????? Code Template，辅助生成模板代码，提高编码效率；l???????? Clean Up，格式化代码并清理或补全代码的相关项，统一代码风格；我们可以通过设置CodeStyle的相关参数，做到满足编码规范的代码风格统一。本文只对Java相关CodeStyle做介绍，JavaScript等的CodeStyle类似。CheckStyle CheckStyle是非常优秀的代码规范检查工具，可以大幅的提高代码质量，在团队开发中经常用来检查代码风格是否统一，以及防范一些编码中潜在的Bug。 目前，Eclipse中可用的CheckStyle插件有：EclipseCS 和 Checkclipse。我们选择EclipseCS，可以在此下载到插件安装包：//。 结合CodeStyle和CheckStyle的功能，很容易就能够做到满足编码规范，代码风格统一。环境设置CodeStyle设置Eclipse中Java的CodeStyle默认使用的是Eclipse的Profile。根据项目需要可以导入自定义的Profile。导入自定义Clean Up Profile打开Eclipse，选择菜单【Window】→【Preferences】，选择左树节点【Java】→【Code Style】→【Clean Up】并点击【Import…】按钮导入自定义Profile： 点击【Apply…】按钮应用该Profile。?导入自定义Code Template Profile打开Eclipse，选择菜单【Window】→【Preferences】，选择左树节点【Java】→【Code Style】→【Code Templates】并点击【Import…】按钮导入自定义Profile： 点击【Apply…】按钮应用该Profile。注意：要将“Automatically and comments for newmethods and types”选中，否则生成文件时不会自动添加相关信息。导入自定义Formatter Profile打开Eclipse，选择菜单【Window】→【Preferences】，选择左树节点【Java】→【Code Style】→【Formatter】并点击【Import…】按钮导入自定义Profile： 点击【Apply…】按钮应用该Profile。导入自定义Import Order Profile打开Eclipse，选择菜单【Window】→【Preferences】，选择左树节点【Java】→【Code Style】→【Organize Imports】并点击【Import…】按钮导入自定义Profile： 点击【Apply…】按钮应用该Profile。通常，将Errors级别的违约修改完了才能够提交代码。使用说明CodeStyle的使用 通常，开发人员在编码时会使用Eclipse相关的快捷键