不同库中同名类的命名约定

时间:2014-03-28 10:39:45

标签: java naming-conventions

在任何具有相对大量依赖项的项目中,在不同的库中总是有很多共同命名的类。例如,Configuration被广泛使用:

enter image description here

它减慢了程序员的速度,因为他必须从列表中仔细挑选正确的类。如果你必须在一个类中使用不同的配置,那么它也会非常恼人,所以它们必须以完整的包名称为前缀。

我正在编写一个也需要Configuration类的库。我应该用这个名字吗?或者将它命名为{Libname}Configuration更好吗?是他们避免这些问题的常用方法吗?

2 个答案:

答案 0 :(得分:0)

我认为你应该以最清楚它的用法命名你的课程,如果存在另一个同名的课程,你就不应该太在意。如您所知,软件包的使用降低了命名冲突的风险。

对于任何项目,我认为整个团队应该有一个与使用的基本命名和格式相关的约定。使用一致的命名约定非常重要,这样当新人处理它时,他们会更快地获取它。我认为惯例也有助于提高生产力,因为它更容易记住名字。

我认为花些时间思考课程是件好事,不仅在算法方面,而且在于他们填写的业务部分。考虑为什么类是必需的以及为项目带来什么,可以让您更加了解方法/类/变量在应用程序工作流中的工作方式。

话虽这么说,我想也许你的IDE有一些选项来隐藏一些类是节目。我使用IntelliJ并且它具有针对这种情况的功能,即使它有点隐藏。

答案 1 :(得分:0)

我认为从一个类的库名开始通常不是一个好主意,只是因为从长远来看会使它更难以记住,并且因为它会降低可读性。

有多种方法可以设置IDE(取决于您使用的IDE),以便自动完成功能首先显示最常用的类。在使用自动完成时,您还可以先键入名称,然后键入库,快速访问课程。这些都取决于您的IDE。但通常,使用库的名称启动类名似乎是一种不好的做法。