Java：目录路径的变量名，一般命名变量

Question

我很难决定如何命名一个File变量和一个String变量，它们都描述了同一个目录。

基本上我有一个String来描述包含测试用例的目录的位置。使用此String我想创建一个File对象。像这样：

String testcaseDirectoryPathString;
File testcaseDirectoryPath = new File(testcaseDirectoryPathString);

我想要实现的是通过选择好的变量名来为我的代码提供最可读性。

我搜索了互联网，但我最终找到了一般的命名惯例，并且建议变量名应该是＆＃39;说＆＃39;。

我的问题是针对一个具体的例子，但我的问题不仅仅是字符串和文件命名，而是一般选择好的变量名。

所以这里有一些问题：

1. 添加单词＆＃39; String＆＃39;是一个好习惯吗？到任何String对象？

2. 添加单词＆＃39; Path＆＃39;这是一个好习惯。到任何File对象？

3. 这是个人偏好的问题吗？没有好的做法？

4. 您如何命名变量以及原因？

如果那里有任何文章，我将非常感谢你指点我。

Answer 1

将“字符串”一词添加到任何String对象是不错的做法？

不，它只是重复了这种类型。使用表示变量含义的名称。

将“Path”这个词添加到任何File对象是不错的做法？

不，见上文。此外，它会给任何读者带来困惑：变量的类型java.io.File还是java.nio.Path？

在您的示例中，我将更改以下内容：

将testcaseDirectoryPath重命名为testcaseDirectory
将testcaseDirectoryPathString重命名为testcaseDirectoryName

Answer 2

这只是我的意见：

1. 将“字符串”一词添加到任何字符串对象是不错的做法？

不，它没有贡献。只需将名称设置得更长，无需在名称中添加类型。

1. 将“路径”一词添加到任何文件对象是不错的做法？

与nº1相同。您不需要变量名称中的类型。

1. 这是个人偏好的问题而且没有良好做法？

总是你需要遵循一个良好的实践编码，使其清晰，记住这一点：

  

“始终将代码视为最终维护代码的人将成为代码   暴力的精神病患者谁知道你住在哪里。“ - John F. Woods。

最重要的是，请尽量遵循公司的命名标准，也许它们不是最好的，但有助于使代码可以骑行。

1. 您如何命名变量以及原因？

我总是尝试用短名称命名我的变量，指定一些重要的东西，并使用英语进行较低级的驼峰案例，即使在西班牙公司工作也不是强制性的。正如我所说，遵循公司的命名标准。

String testcaseDirectoryPathString;

File testcaseDirectoryPath = new File(testcaseDirectoryPathString);

如果我没有其他目录路径，我可以使用它：

String directoryPath;

File <<something that describe the result file>> = new File(directoryPath);

<<something that describe the result file>>我的意思是prizeRepresentations，annualSales等......

关闭记录 如果您使用eclipse，您可以看到插件checkstyle和pmd，它们将帮助您获得干净清晰的代码并习惯于以这种方式工作。

Answer 3

一般指南是：

• 具体而言，如果您阅读了字段/变量名称，请弄清楚它的用途，但不要过分。务必以局外人的眼光来检查。您是否希望查看并使用名为businessRegulationSecondServiceFactoryInstanceFromASingleton的字段？另一方面，永远不要使用一个字符字段变量，只要它是循环的一个非常基本的索引。
• 不需要重复String，因为所有IDE都会帮助您确定类型。
• 如果不是必要则避免否定，例如'boolean notDisabled'使用'boolean enabled'。
• 保持你的名字整洁，并通过你的代码使用可识别的模式，如果有人评论你的java文件，在第二或第三课，那个人应该得到你的编程风格的图片，他应该期待什么样的代码的其他部分。

获取有关https://softwareengineering.stackexchange.com/的指导。本主题中有许多问题。通常与“良好实践”和“命名惯例”一起