建议类型名称和生命名称应避免使用缩写。还建议源代码行宽应为 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/