java - 缩写还是全称?

标签 java coding-style naming-conventions

建议类型名称和生命名称应避免使用缩写。还建议源代码行宽应为 80 或最多 120 个字符,即使使用现代宽屏显示器也是如此。

这是我们实际项目中的一行:

final PimAuthoringApplicationMappingReader pimAuthoringApplicationMappingReader = 
      new PimAuthoringApplicationMappingReader(pimAuthoringApplicationMappingFile);

一个简单的新操作至少占用了 2 行,即使我们在这里已经使用了缩写 (Pim = ProIntralink Merge)。

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

问题:处理这种情况的更好方法是什么?是否推荐使用“合理”的缩写 - 例如:

 final PimAuthAppMapReader pimAuthAppMapReader=new PimAuthAppMapReader(pimAuthAppMapFile);

?

最佳答案

这是一个熟悉的问题,我正在处理的 Java 项目有一些类让我出于同样的原因挠头。我在缩短类名之前先缩短局部变量名,但如果结果合理,我也可以缩短类名。

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

在您的示例中,我可以将 Application 缩短为 App,但不太确定是否可以将 Mapping 缩短为 Map,因为“map”在 Java 中具有不同的主要含义(第一个关联)。

关于java - 缩写还是全称?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/8532115/

相关文章:

java - 从 Swing 应用程序创建 Web 应用程序

java - 立即向下转换有什么好处?

date - 日期格式 "YYYY-MM-DD HH:MM:SS"有名称吗?

naming-conventions - Kotlin 的文件命名约定

forms - 在表单字段标签中使用正确的语言

java - 在 DJ Native Web 浏览器中操作链接

java - setTickLabelRotation(-90) 不适用于水平 CategoryAxis

java - 使用 PDFBox 打印 PDF 永远不会完成

functional-programming - 有没有更简洁的方式来编写这段代码?

android - 在不向每个 TextView 添加样式属性的情况下对所有 TextView(或自定义 View )进行样式设置