Java 缩写还是全名?

Java 缩写还是全名?,java,coding-style,naming-conventions,Java,Coding Style,Naming Conventions,建议类型名和病毒名避免使用缩写。即使使用现代宽屏幕显示器,也建议源线宽应为80或最多120个字符 下面是我们真实项目的一句话: final PimAuthoringApplicationMappingReader pimAuthoringApplicationMappingReader = new PimAuthoringApplicationMappingReader(pimAuthoringApplicationMappingFile); 一个简单的新操作至少占用了2行,尽管

建议类型名和病毒名避免使用缩写。即使使用现代宽屏幕显示器,也建议源线宽应为80或最多120个字符

下面是我们真实项目的一句话:

final PimAuthoringApplicationMappingReader pimAuthoringApplicationMappingReader = 
      new PimAuthoringApplicationMappingReader(pimAuthoringApplicationMappingFile);
一个简单的新操作至少占用了2行,尽管我们已经在这里使用了缩写(Pim=ProIntralink Merge)

虽然用这种方法很容易理解每个单词,但它使简单的方法变得更长,因此很难在屏幕上使用一种方法

问题:处理这个案件的更好方法是什么?是否建议使用“合理”缩写-例如:

 final PimAuthAppMapReader pimAuthAppMapReader=new PimAuthAppMapReader(pimAuthAppMapFile);

这是一个常见的问题,我正在处理的Java项目有一些类,出于同样的原因,它们让我抓狂。我在缩短类名之前先缩短局部变量名,但如果结果合理,缩短类名没有问题

打破局部变量与其类型同名的惯例,在这些情况下会释放相当多的空间。如果需要更多的空间,我也可以缩短类型名


在您的示例中,我可以将应用程序缩短为应用程序,但不能确定是否要将映射缩短为Map,因为“Map”在Java中有不同的主要含义(第一个关联)。

这是一个熟悉的问题,我正在处理的Java项目中有一些类让我挠头。我在缩短类名之前先缩短局部变量名,但如果结果合理,缩短类名没有问题

打破局部变量与其类型同名的惯例,在这些情况下会释放相当多的空间。如果需要更多的空间,我也可以缩短类型名


在您的示例中,我可以将应用程序缩短到应用程序,但不能确定是否要将映射缩短到映射,因为“映射”在Java中有不同的主要含义(第一个关联)。

我总是发现用与实现的类(或接口)相同的名称命名变量的想法很奇怪。缩短的名字也一样

在对象声明的上下文中,它没有给出关于对象真正用途的信息,而且当您有多个1并且使用数字作为后缀时,情况往往会变得更糟


因此,取而代之的是,使用一个名称来描述上下文中对象的意图,几个月后查看代码时会更容易。

我总是觉得用与实现的类(或接口)相同的名称命名变量的想法很奇怪。缩短的名字也一样

在对象声明的上下文中,它没有给出关于对象真正用途的信息,而且当您有多个1并且使用数字作为后缀时,情况往往会变得更糟


因此,取而代之的是,使用一个描述上下文中对象意图的名称,几个月后查看代码时会更容易。

最重要的是,代码必须力求清晰。一般来说,这意味着不要缩写,但在某些情况下,常用缩写可以提高清晰度。通常情况下,首字母缩略词不会拼写出来,但应尽量将首字母缩略词视为一个单词,而不是保留“所有大写字母”的首字母缩略词。
下面是我所说的例子:

HtmlRequest (not HTMLRequest)
App instead of Application
XmlProcessr instead of XMLProcessor
etc

不要担心页面宽度。担心可读性

最重要的是,代码必须力求清晰。一般来说,这意味着不要缩写,但在某些情况下,常用缩写可以提高清晰度。通常情况下,首字母缩略词不会拼写出来,但应尽量将首字母缩略词视为一个单词,而不是保留“所有大写字母”的首字母缩略词。
下面是我所说的例子:

HtmlRequest (not HTMLRequest)
App instead of Application
XmlProcessr instead of XMLProcessor
etc

不要担心页面宽度。担心可读性

我会保持类名冗长,并将变量名缩短为更合理的名称。看看你的例子,我认为这是一个合理的努力:

final PimAuthoringApplicationMappingReader pimMappingReader = 
      new PimAuthoringApplicationMappingReader(pimMappingFile);
请记住,阅读您的代码的人能够在您编写代码时轻松地引用变量的类型

  • 为特定目的定义类
  • 保持你的方法简洁
  • 在使用变量的地方声明变量
  • 如果没有使用非常相似的名称定义其他类型,那么我上面的示例是有意义的。你甚至可以说,如果在同一个方法中没有太多其他事情发生,并且变量是局部作用域的,那么这仍然是有意义的

    final PimAuthoringApplicationMappingReader pimReader = 
          new PimAuthoringApplicationMappingReader(pimFile);
    
    我不会缩短类名,因为您可能在没有任何上下文(例如API文档、配置文件等)的情况下阅读它们


    但最重要的是,要努力做到代码一致。如果已经使用了某个样式,请遵循它,除非您让所有人都同意对其进行更改。

    我将保持类名的详细性,并将变量名缩短为更合理的名称。看看你的例子,我认为这是一个合理的努力:

    final PimAuthoringApplicationMappingReader pimMappingReader = 
          new PimAuthoringApplicationMappingReader(pimMappingFile);
    
    请记住,阅读您的代码的人能够在您编写代码时轻松地引用变量的类型

  • 为特定目的定义类
  • 保持你的方法简洁
  • 在使用变量的地方声明变量
  • 如果没有使用非常相似的名称定义其他类型,那么我上面的示例是有意义的。你甚至可以说,如果在同一个方法中没有太多其他事情发生,并且变量是局部作用域的,那么这仍然是有意义的

    final PimAuthoringApplicationMappingReader pimReader = 
          new PimAuthoringApplicationMappingReader(pimFile);
    
    我不会缩短类名,因为您可能在没有任何上下文(例如API文档、配置文件等)的情况下阅读它们


    但最重要的是,要努力做到代码一致。如果已经使用了某个样式,请遵循该样式,除非您让所有人都同意对其进行更改。

    我在IDE中使用比例字体,因此屏幕上大约有180个字符。在这一点上,我包装代码。但是Java代码惯例建议使用80个字符,即使大多数开发人员可能不这么做,我也不希望这个建议会改变