我们已经开始了一个新的阶段,这个阶段的开始并不顺利,因为我遇到了一个原来并不是很常见的问题,我竟然找不到合适的API供我使用,而且是我们系统的基础服务的API,原因不是别的,就是因为命名规范,第一是方法名,原来的很多API的方法名就是开发人员随意取的(我们没有编码规范或者说命名规范),一个公共的Session Bean的Proxy的方法名竟然叫getAll,而它仅仅是返回一个特定的对象的集合,一般这样的方法都应该叫getAllXxxx,第二是有些术语修改了,但是只是把界面上用户可以看到的文字修改了,后台的API的方法名和类名都没有修改,如果你不是相关的开发人员,你怎么可能弄清楚呢?而原来为什么没有修改方法呢?很简单,一些少数的地方使用反射调用,所以用IDE的重构方法可能会漏掉一些地方,所以他们不敢改,举一个真实的例子说明这个命名的修改导致了多么大的问题:
app group-> app
app template -> component
app -> component instance
说实话,在这一点上,我们的产品实在是失败,因为自从我做开发依赖,所去过的公司还没有说哪个公司没有命名规范的。
分享到:
相关推荐
编码规范第二、可以提高代码质量,谁编程都不是一次性完成的,是需要不断的测试与调试,以各种状态来修改自己的代码,而将代码规范化,就能对程序本身有更加清晰的结构思路,从而减少调试而成为快捷高效的代码。...
开发代码编程命名规范.pdf
C#代码命名规范
java 开发命名规范 java 开发命名规范 java 开发命名规范
JAVA命名规范 新手得好好看看 Java-开发命名规范
详细讲解了程序开发过程中说需要遵守的命名规则。
java 代码 命名 规范 .doc 注释
java代码命名规范
1. 模块命名、数据库表命名、域模型命名、各分层的类/方法命名、页面的命名; 模块命名: a. 包命名:com.project_name.module_name.action/service/dao/ws; service的实现都置于...
java变法规范 包括命名规范 代码检查 细化到包 类 源程序等的命名方式 方法 接口名的书写规范等
Python代码规范和命名规范
Java初学者没有规范的命名习惯,会给以后的开发带来麻烦,最好就是在初学的时候注意变量、函数等的命名
C#命名规范和开发习惯C#命名规范和开C#命名规范和开发习惯发习惯
通过遵循有意义的名称、使用适当的命名约定(如小驼峰和大驼峰命名法)、避免使用保留字以及保持名称的简洁性,开发人员可以创建出清晰、易读和可维护的代码。这不仅提高了代码的可读性,还有助于减少错误、提高开发...
苍穹开发命名规范
首先介绍了JavaScript的用途、发展状况,以及JavaScript的3大组成部分及其与ECMAScript的关系,然后讲解了常用开发工具相关的内容,接着针对JavaScript的入门知识进行了介绍,包括代码书写位置、注释、输入输出语句...
C#代码开发命名规范示例.doc
.NET 开发命名规范 C# 开发命名规范 ADO 开发命名规范
阿里巴巴Java开发命名规范