Java：目录路径的变量名，一般命名变量[关闭]

Question

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

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

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

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

我搜索了互联网，但我最终找到了一般的命名约定以及变量名应该“说话”的建议。

我的问题是针对特定示例的，但我的问题不仅在于字符串和文件命名，还在于通常选择好的变量名称。

所以这里有一些问题：

1. 将单词“String”添加到任何 String 对象是一种好习惯吗？

2. 将“路径”一词添加到任何文件对象是否是一种好习惯？

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

4. 如何命名变量以及为什么？

如果有任何文章，我会很感激你指点我。

Answer 1

这只是我的意见：

1. 将“String”一词添加到任何 String 对象是一种好习惯吗？

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

1. 将“路径”一词添加到任何文件对象是否是一种好习惯？

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

1. 这是个人喜好问题，没有好的做法吗？

始终需要遵循良好的编码习惯以使其清晰易读，请记住这一点：

“始终编写代码，就好像最终维护您的代码的人将是 知道你住在哪里的暴力精神病患者。” - 约翰·F·伍兹。

最重要的是，请始终遵循公司命名标准，也许它们不是最好的，但有助于使代码易于使用。

4. 如何命名变量以及为什么？

我总是尝试用短名称来命名我的变量，指定一些重要的东西，并使用英语遵循小写字母，即使在一家非强制性的西班牙公司工作也是如此。正如我所说，遵循公司命名标准。

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 2

将“String”一词添加到任何 String 对象是一种好习惯吗？

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

---

将“路径”一词添加到任何文件对象是一种好习惯吗？

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

---

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

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

Answer 3

一般指南是：

• 具体一点，如果您阅读了您的字段/变量名称，请了解它的用途，但不要过度使用。总是用局外人的眼光来检查。您想查看并使用名为 businessRegulationSecondServiceFactoryInstanceFromASingleton 的字段吗？另一方面，永远不要使用一个字符字段，变量，只有当它是循环的一个非常基本的索引时。
• 不需要重复字符串，因为所有 IDE 都会帮助您确定类型。
• 如果没有必要，请避免否定，例如 'boolean notDisabled' 使用 'boolean enabled'。
• 保持你的名字整洁，并在你的代码中使用可识别的模式，如果有人在第二或第三类审查你的 java 文件，那个人应该了解你的编程风格，他应该期待什么代码的其他部分。

获取有关https://softwareengineering.stackexchange.com/ 的指导，此主题中有许多问题。通常与“良好做法”和“命名约定”一起使用