`
cherami
  • 浏览: 211590 次
  • 性别: Icon_minigender_1
  • 来自: 上海
社区版块
存档分类
最新评论

没有命名规范的代码是开发人员的地狱

    博客分类:
  • Java
阅读更多

我们已经开始了一个新的阶段,这个阶段的开始并不顺利,因为我遇到了一个原来并不是很常见的问题,我竟然找不到合适的API供我使用,而且是我们系统的基础服务的API,原因不是别的,就是因为命名规范,第一是方法名,原来的很多API的方法名就是开发人员随意取的(我们没有编码规范或者说命名规范),一个公共的Session Bean的Proxy的方法名竟然叫getAll,而它仅仅是返回一个特定的对象的集合,一般这样的方法都应该叫getAllXxxx,第二是有些术语修改了,但是只是把界面上用户可以看到的文字修改了,后台的API的方法名和类名都没有修改,如果你不是相关的开发人员,你怎么可能弄清楚呢?而原来为什么没有修改方法呢?很简单,一些少数的地方使用反射调用,所以用IDE的重构方法可能会漏掉一些地方,所以他们不敢改,举一个真实的例子说明这个命名的修改导致了多么大的问题:
app group-> app
app template -> component
app -> component instance
说实话,在这一点上,我们的产品实在是失败,因为自从我做开发依赖,所去过的公司还没有说哪个公司没有命名规范的。

分享到:
评论

相关推荐

    阿里前端开发规范(word文档)

    阿里前端开发规范是阿里巴巴集团为前端工程师制定的一套详尽的工作指南,旨在提高代码质量、提升团队协作效率、保持代码一致性。这套规范涵盖了HTML、CSS、JavaScript、工程化、性能优化等多个方面,对于任何前端...

    java开发规范.net开发规范JS开发规范应用开发接口规范.zip

    在软件开发过程中,遵循一定的规范和标准至关重要,它有助于提高代码质量、提升团队协作效率以及降低维护成本。这里我们主要探讨Java、.NET和JavaScript三种编程语言的开发规范,以及应用开发接口规范。 1. Java...

    前端开发规范手册合集.zip

    《前端开发规范手册合集》是一份集合了前端开发各个层面规范的综合资源,旨在提升团队协作效率,保证代码质量,以及实现项目的可维护性和可扩展性。这份压缩包包含了以下主要内容: 1. **前端开发基本规范**:这...

    敏捷开发流程 之 junit提高代码覆盖率

    每个开发团队都应该制定一套编码规范,包括但不限于代码缩进、程序块结构、命名规则、文档标准和编程实践。例如,对于命名规则,类名通常采用驼峰式命名,变量名清晰易懂,异常处理要明确且适当,避免过于复杂的逻辑...

    Java后台和HTML前端开发代码规范.zip

    在软件开发过程中,代码规范是确保项目质量和团队协作效率的关键因素。本压缩包"Java后台和HTML前端开发代码规范.zip"提供了针对Java后端和HTML前端的开发规范,旨在指导开发者遵循一致的编码风格和最佳实践,从而...

    前端代码规范总结(3篇).zip

    在前端开发领域,代码规范是确保项目质量和团队协作效率的关键因素。本文将深入探讨HTML、CSS和JavaScript这三种主要前端技术的代码规范,旨在提供一套综合的指导原则,帮助开发者编写更可读、可维护和可扩展的代码...

    前端开发规范1

    在前端开发中,规范化编码是提高代码可读性、可维护性和团队协作效率的重要手段。以下是对【标题】"前端开发规范1"所涵盖的【描述】内容的详细说明: **CSS开发规范** 1. **命名规则** (CSS1001-CSS1003): 命名...

    web前端开发各种规范

    在web前端开发中,规范的重要性不言而喻。它们不仅有助于保持代码的整洁性和一致性,还可以提高团队协作效率,使得代码更易于维护和扩展。以下是一些关于web前端开发的各种规范,包括源码规范、工具使用等方面的详细...

    Android-Android的代码规范总结以及一些实用常用的工具类

    在Android开发过程中,遵循良好的代码规范是至关重要的,它不仅能够提高代码的可读性和可维护性,还能提升团队合作的效率。同时,利用实用的工具类可以简化我们的开发工作,提高开发效率。以下是对"Android的代码...

    UI 开发 详细 规范

    在UI开发领域,详细规范是确保项目质量和团队协作效率的关键。UI(用户界面)开发主要涉及前端部分,包括HTML、CSS和JavaScript等技术,这些技术共同构建了用户与应用程序交互的视觉界面。以下是对这些技术的详细...

    前端开发规范12345.zip

    1. **命名规范**:良好的命名习惯是提高代码可读性的基础。JavaScript中的命名应遵循驼峰式(camelCase)或下划线分隔(snake_case)规则,变量、函数、类的命名需清晰反映其用途。此外,还应区分常量(全大写,...

    .net开发代码编写标准

    在.NET开发过程中,遵循一套规范和标准至关重要,它不仅可以提高代码质量,使代码更易于维护,还能提升团队协作效率。以下是一些针对Web开发人员,尤其是.NET环境中的关键编码标准和最佳实践: 1. **命名规范**:...

    Web前端开发规范相关文档

    Web前端开发规范是确保团队协同工作、代码质量与可维护性的重要基石。这些规范涵盖了HTML、CSS、JavaScript、版本控制、代码格式化、性能优化等多个方面。以下是对这些规范的详细解析: 1. **HTML规范**:HTML是...

    前端vue,html,js开发规范,前端vue,html,js开发规范

    在前端开发中,遵循一套统一的开发规范至关重要,它能够提高代码质量,增强代码可读性和维护性,降低团队协作中的误解与冲突。本篇主要介绍Vue.js、HTML和JavaScript的开发规范,按照阿里前端开发规范目录进行详细...

    FrontEndChecklist针对现代网站和开发人员的完美前端检查清单checklist

    1. **代码结构与组织**:确保代码结构清晰,遵循模块化和组件化原则,如使用ES6模块或CommonJS规范来组织代码。 2. **错误处理**:正确地捕获和处理运行时错误,使用try-catch语句,以及集成全局错误监听机制。 3....

    阿里代码规范 1.4版本和1.3终极版集合

    阿里代码规范是阿里巴巴集团为了提升代码质量和开发效率而制定的一套详细、严谨的编码规则,它涵盖了Java、JavaScript、Python等多门编程语言。1.4版本和1.3终极版集合代表了这一规范在不同阶段的发展和完善。下面将...

    垃圾代码和优质代码的区别?(csdn)————程序.pdf

    【垃圾代码与优质代码的区别】 垃圾代码和优质代码之间的区别主要...当代码质量高时,开发人员可以更高效地定位和解决问题,减少维护成本,提高用户满意度。因此,区分并改进垃圾代码和优质代码对软件开发至关重要。

    JavaScript 程序编码规范(pdf).rar

    总之,《JavaScript程序编码规范》这份PDF文档详细阐述了编写高质量JavaScript代码所需遵循的准则,通过理解和实践这些规范,开发者能够编写出更专业、更易维护的代码,提升团队的开发效率和代码质量。

    非阿里的-前端开发规范手册.rar

    在前端开发领域,遵循一套合理的开发规范是至关重要的,它能确保代码的可读性、可维护性和团队协作的效率。这份名为“非阿里的-前端开发规范手册”的文档,虽然不直接来自阿里巴巴集团,但依然为JavaScript、HTML和...

Global site tag (gtag.js) - Google Analytics