`
wdmcygah
  • 浏览: 62290 次
社区版块
存档分类
最新评论

Java编码规范—"约定"也要"配置"

阅读更多

没有规矩,不成方圆。Java开发亦如是。在团队协作开发的过程中,如若遵守统一的编码规范,会让代码的可读性更好,团队协作的效率也能相应地得到提升。因此规范虽不是一项技术,却是不可不重视的“约定”。 

很多公司都有自己相应的编码规范,如果还没有可以参考Google的编码风格指南: 

英文版:http://google-styleguide.googlecode.com/svn/trunk/javaguide.html

中文版:http://www.cnblogs.com/lanxuezaipiao/p/3534447.html#Javadoc 

知道了规范,彻底地贯彻实施是一个难题。若是希望团队成员都自觉地遵守,而且没有偏差确也不是件易事,此时统一的“配置”便显得格外重要了。要求每个团队开发成员在开发环境中配置统一的规范文件,借助于工具轻松地保证规范的遵守,此时便省时省力又省心了。 

例如Eclipse中,可以使用code templates设置保证生成的编码文件的风格一致,可以使用formatter配置保证格式化代码的一致性,可以配置checkstyle检查编码风格是否符合统一的规范。具体的配置方式可以参考: 

Eclipse Code Templates设置:http://chenzhou123520.iteye.com/blog/1625629

Eclipse Formatter设置:http://xm-koma.iteye.com/blog/2103643

Eclipse CheckStyle设置:http://chenzhou123520.iteye.com/blog/1627618


简单的东西往往容易忽视,忽视它的重要性,忽视它的存在合理性。如果你还没有意识到规范的重要性,或者苦于实施,希望本文能够对你有所帮助。

分享到:
评论

相关推荐

    JAVA程序编码规范.pdf

    从提供的文件内容可以看出,该文件是一份关于JAVA程序编码规范的指南。文件详细介绍了在编写JAVA代码时应遵循的各项规则和标准,目的是为了提高代码的可读性和维护性,同时确保不同的开发者之间能够有一致的编程风格...

    java代码规范示例

    "java代码规范示例" Java 代码规范示例中,涵盖了 Java 项目中包、类、方法、...这个 Java 代码示例提供了一个完整的 FTP 帮助类的实现,涵盖了 Java 项目中的各种规范和约定,包括包名、类名、方法名、注释等方面。

    java编码规范

    本文将深入探讨Java编码规范,涵盖基本编码规则、SSH(Spring、Struts、Hibernate)框架的编码规范以及数据库命名规则。 1. **Java基本编码规则** - **命名规范**:类名首字母大写,采用驼峰式命名,如`MyClass`...

    java编码规范.doc

    Java编码规范是开发人员遵循的一系列指导原则和约定,确保代码的一致性和质量。它涵盖了文件组织、命名约定、代码结构和风格等多个方面。遵循这些规范有助于减少错误,提升代码的可读性,并使得不同开发者之间的合作...

    编码规范 注释规范 代码风格 JAVA

    总结来说,理解和遵循编码规范、注释规范以及代码风格对于任何Java开发者都是至关重要的。华为的这些资源提供了一套完整的框架,旨在帮助开发团队产出高质量、易维护的代码。通过深入学习和应用这些规范,开发者不仅...

    网进科技JAVA编码规范

    网进科技的JAVA编码规范强调了文件组织、命名约定以及测试代码的管理,旨在创建一致性和可维护性。遵循这些规则,开发者可以编写出更高质量的代码,降低维护成本,并提高团队间的协作效率。通过统一的包名和类名,...

    java编码规范_new .rar

    这份"java编码规范_new .rar"文件很可能包含了针对Java开发者的详细指南,旨在帮助他们编写整洁、一致的代码。 首先,编码规范通常会涵盖以下几个方面: 1. **命名规范**:变量、类、接口、方法的命名应当清晰、...

    中央java编码规范

    综上所述,中央Java编码规范涵盖了从基本的命名约定到高级的最佳实践,旨在帮助开发者编写出高质量、高效率的Java代码。这些规范不仅有助于提升个人技能,还能促进团队合作,提高项目的整体质量。

    编程语言Java编码规范.pdf

    Java编码规范是一套为了保持代码的可读性、一致性和可维护性而制定的规则和约定。这些规范通常涉及文件命名、代码格式、注释规范、命名约定和编程实践等各个方面。本文将基于提供的文件内容,详细解释这些Java编程...

    Java语言编码规范

    所有开发者在编写Java代码时,均需严格遵守编码规范,即使规范中未明确提及的细节,也应遵循通用的最佳实践,确保代码的一致性和可维护性。 #### 2. 文件名与组织 文件名和组织结构直接影响到代码库的清晰度和查找...

    Java项目编码规范.pdf

    - **1.2 参考资料**:编码规范通常基于业界广泛接受的标准,如Oracle的Java编码规范,Google的Java编程指南等,这些资源可以为开发者提供进一步学习的依据。 2. **文件名** - **2.1 文件命名**:文件名应清晰反映...

    sun公司推荐的Java编码规范.doc

    Java编码规范是编程界的一种约定,旨在提高代码的可读性、可维护性和团队协作效率。Sun公司(现已被Oracle收购)作为Java的创造者,为Java开发者制定了一套推荐的编码规范,以确保代码的一致性和专业性。这份文档...

    Java EE 编码规范.docx

    ### Java EE 编码规范详解 #### 一、规范存在的意义 编码规范是软件开发过程中不可或缺的一部分,它有助于提升代码质量、确保项目的一致性和可维护性。具体来说,良好的编码规范具有以下重要意义: 1. **减少维护...

    java代码格式配置文件

    3. **.checkstyle** 文件:Checkstyle是一个静态代码分析工具,它能检查Java代码是否符合设定的编码规范。`.checkstyle`文件包含了Checkstyle的配置,定义了违反哪些规则会触发警告或错误。通过在构建过程中集成...

    java开发约定与规范

    ### Java开发约定与规范 #### 一、引言 在软件开发过程中,遵循一套明确的开发规范至关重要。它不仅能提高代码的可读性和可维护性,还能促进团队间的协作效率。本文将详细介绍一份针对Java开发者的命名规范指南,...

    JAVA代码检查工具

    Java编码规范包括但不限于以下几点: - 变量和方法的命名应清晰、简洁,遵循驼峰命名法。 - 注释应该提供足够的信息,解释代码的功能和目的。 - 使用适当的缩进和空格,使代码结构清晰。 - 避免使用全局变量,...

    Nutz Java 编码规范 (V1.0).doc

    【Nutz Java 编码规范 (V1.0)】...综上所述,Nutz Java编码规范强调代码的清晰性和一致性,通过命名约定、注释规范和访问控制来提升代码的可读性和维护性。开发者应当遵循这些规则,以保证代码的质量和团队协作的效率。

    Java代码规范.pdf

    本文将根据提供的《Java代码规范.pdf》文件中的内容,详细解释Java编码规范的重要性及其具体实践。 #### 二、为什么要有编码规范? 1. **提高可维护性**:大多数软件在其生命周期内都需要进行多次维护。遵循统一的...

Global site tag (gtag.js) - Google Analytics