`
cantellow
  • 浏览: 847291 次
  • 性别: Icon_minigender_1
  • 来自: 草帽海贼团
社区版块
存档分类
最新评论

代码质量实践之统一代码风格

 
阅读更多

前几篇文章中一直在强调代码质量,理论性很强,但实践性很低,平时我也关注这方面的工具和平台,以前开发中经常遇到很多人的代码风格不统一,在新的公司我发现这方面已经做的不错了,于是我总结了一下,希望对困惑于代码风格不能统一的各位有所帮助。

 

1.统一eclipse版本,最好由技术委员会统一制定eclipse标准,安装好各种插件,比如maven插件、findbugs、SCM插件等等。我以前遇到过如果eclipse版本不一样,format出来的代码风格也不一样。

 

2.统一format和clean up模板,最好还是制定一个公司级别的format和clean up模板,然后要求每个人都导进去。如果没有合适的format和clean up模板,建议采用eclipse默认的即可。

 

3.统一注释风格,我们有时候需要知道代码创建和修改的作者、时间和原因等等,这些因素对后续代码的维护有莫大的帮助,但是很多人都忽略了这点,所以我建议注释风格也需要统一。

 

/**
 * xxx公司版权所有
 * @author xuze(cantellow)
 * @Email xuze@xxx.com
 * ${date} ${time}
 * ${todo}
 * @Modify
 */
 

最后一点,也是最重要的一点,很多人都执行上面的步骤,但是很少人去执行ctrl+shift+F,解决方法是配置“save actions”,位置是windows—》preferences—》Java—》editor—》save actions,将“Format source code”打上勾,另外你还可以添加一些“additional actions”。

你所定制的这些规则,当你保存文件时会触发,也就是说,当每一次编辑文件执行保存动作时,都会执行format操作以及附带的additional操作,这就强制了format,我相信有人不愿意去执行ctrl+shift+F,但没有不修改并保存源文件的吧。

 

下面是我的“save actions”配置:


  • 大小: 34 KB
4
2
分享到:
评论

相关推荐

    iOS代码风格统一规范

    本篇文章将详细阐述一份针对iOS开发的代码风格规范,涵盖常见的代码格式化规则、编程最佳实践以及代码组织方式等内容。通过这些规定,可以有效地提升团队合作效率,减少因个人编码习惯差异而产生的沟通成本。 #### ...

    eclipse优秀代码风格

    5. **应用到整个项目**:为了使整个项目统一代码风格,可以使用“Source”菜单下的“Clean Up”功能,选择合适的清理规则,对项目进行格式化。 6. **团队协作**:如果是在团队环境中,可以将代码风格配置文件加入...

    统一文件编码和代码风格,提高代码可读性

    综上所述,统一文件编码和代码风格是提升代码质量,增强团队协作效率,以及保证长期项目可维护性的基石。通过选择合适的编码格式,遵循明确的代码风格指导,以及利用自动化工具,开发者可以创建出更加整洁、一致且易...

    swift-关于iOS代码风格管理的两三事儿

    本篇将深入探讨如何在Swift项目中进行有效的代码风格管理,以提高代码质量,确保团队一致性。 首先,我们来了解代码风格管理的重要性。代码风格不仅影响代码的可读性和可维护性,还直接关系到开发者的开发效率。...

    我的代码风格

    7. **代码审查**:通过同行评审,让其他开发者对你的代码风格打分,是提高代码质量的有效方式。这可以帮助发现潜在的问题,同时也能学习到他人的优秀实践。 8. **持续学习与更新**:编码风格随着时间和技术的发展会...

    IBM java代码质量专题

    在IT行业中,尤其是在软件开发领域,代码质量是衡量一个项目成功与否的关键因素之一。IBM作为全球领先的科技企业,其在Java代码质量方面的专题探讨,无疑为业界提供了宝贵的指导与实践案例。以下是从“IBM Java代码...

    优雅的代码风格

    优雅的代码风格是编程实践中的一种追求,它不仅关乎代码的可读性和可维护性,还直接影响到团队协作的效率和软件质量。在C#编程语言中,遵循一定的编码规范和最佳实践,可以使代码更加优雅、易读且易于理解。本文将...

    敏捷开发中高质量 Java 代码开发实践.doc

    在敏捷开发中,实现高质量的Java代码开发实践是一项关键任务,旨在解决由于团队经验差异、编码风格不统一及缺乏规范管理导致的代码质量问题。高质量的代码不仅易于维护,还能减少测试投入,提高开发效率。以下是五个...

    代码规范+-+PHP+代码风格检查_修复工具_修复脚本_php_php编程_

    在IT行业中,编程规范是确保代码可读性、可维护性和团队协作效率的重要基石。...通过使用PHP_CodeSniffer、PHP-CS-Fixer等工具,开发者可以轻松实现代码风格的标准化,从而提高代码质量,使项目更加健壮和易于维护。

    利用shell脚本修正代码风格 - Eating my own dog food

    在IT行业中,代码风格一致性是团队协作和代码可读性的重要因素。良好的代码风格不仅可以提高代码...通过学习这些内容,开发者可以提升自己在代码风格统一和自动化工具方面的技能,使得代码更加整洁,提高团队合作效率。

    敏捷开发中编写高质量Java代码

    统一编码规范是确保项目代码风格一致性的基础。这不仅有助于新成员快速融入团队,还能减少因风格差异带来的沟通成本。例如,团队可以参考《Java编码规范》(The Elements of Java Style)等书籍来制定一套编码标准,...

    C#代码标准风格,最新的

    通过以上内容的详细介绍,我们可以看到《C#代码标准风格》是一份非常全面且实用的编程规范指南,不仅包含了技术性的编程规则,还融入了大量的实践经验分享,对于提高C#开发者的编程技能和代码质量具有重要的指导意义...

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

    在IT行业中,编程规范、注释规范以及代码风格是软件开发中的重要组成部分,尤其是在大型企业如华为这样的公司中,它们被视为保证代码质量、提高团队协作效率的关键准则。这些规范不仅有助于提升代码的可读性和可维护...

    代码质量控制(checkstyle)

    Checkstyle作为代码质量控制的重要工具,可以帮助开发者和团队实现统一的编码规范,提升代码质量,降低维护成本。通过定制化的配置,Checkstyle能适应各种项目需求,成为保障软件质量的得力助手。因此,了解和掌握...

    代码风格与编程规范-Programming Style

    一个良好的代码风格可以使代码更容易理解,减少团队协作时的沟通成本,提高代码质量,降低未来维护的难度。本规范旨在为开发者提供一套通用的编程指导原则,以实现代码的一致性、简洁性和高效性。 **II. 名字** 1....

    提高代码质量的157个建议

    在编程领域,代码质量至关重要,...以上仅是提高C#代码质量的一部分建议,实际应用中,还需要结合具体项目和团队实践,不断学习和改进。阅读“编写高质量代码改善C#程序的157个建议”PDF,将提供更为详细和全面的指导。

    Matlab代码风格

    MATLAB作为一种广泛应用于科学计算、算法开发及数据分析领域的高级编程语言,其代码风格的标准化对于提高代码质量及团队协作效率具有重要意义。 ### 代码格式规范 在MATLAB中,代码格式的规范主要体现在以下几个...

    代码阅读方法与实践

    通过《代码阅读方法与实践》这本书,读者不仅可以学到关于代码风格的基础知识,还能了解到如何通过实践来提高代码的质量。本书通过具体的示例分析,强调了良好的代码风格对于软件开发的重要性,并提供了实用的指南来...

    Megma综合工具代码风格的资料.rar

    在开发过程中,统一的代码风格不仅能够使代码更易于理解和维护,还有助于团队之间的沟通。通过遵循这些指导原则,开发者可以避免因个人编程习惯差异导致的混乱,减少代码冲突,并使得新成员能更快地融入到项目中。...

Global site tag (gtag.js) - Google Analytics