命名包含文件名的变量？

Question

如果我有一个包含文件完全限定名称（例如项目文件）的变量，它应该被称为 projectFile、projectFileName 或 项目路径？ 或者是其他东西？

Answer 1

这取决于您的环境中使用的命名约定，例如在 Python 中，由于 os.path 模块。

>>> import os.path
>>> path = "/path/to/tmp.txt"
>>> os.path.abspath(path)
'c:\\path\\to\\tmp.txt'
>>> os.path.split(path)
('/path/to', 'tmp.txt')
>>> os.path.dirname(path)
'/path/to'
>>> os.path.basename(path)
'tmp.txt'
>>> os.path.splitext(_)
('tmp', '.txt')

Answer 2

我通常使用这些：

• FileName 仅用于文件名（不带路径）
• FilePath 仅用于父路径（不带文件名）
• FileFullName对于带有路径的完全限定名称，

我认为不存在公认的标准。 我取决于您（团队）的偏好以及您是否需要在给定情况下区分这三者。

编辑：我对这些特定命名约定的想法是：

• 直观上，“名称”是一个字符串，“路径”（和“文件名”）也是一个字符串，
• “名称”是相对的，除非它是“全名”
• 相关变量名称应该以相同的前缀（“文件”+...）开头，我认为这提高了可读性
• 具体/属性是右分支：“文件”-> “FileName”
• 特化是左分支：“FileName”-> “ProjectFileName”（或“ProjectFileFullName”）
• “File”是代表物理对象的对象/句柄，因此“ProjectFile”不能是字符串

我不能总是坚持这些约定，但我尝试这样做。 如果我决定使用特定的命名模式，即使这意味着我必须编写更具描述性（=更长）的变量名称，我也会保持一致。 阅读代码的次数多于编写代码的次数，因此额外的少量输入并不会太困扰我。

Answer 3

System.IO.Path 似乎将文件的完全限定名称称为 path，将文件本身的名称称为 filename，并将其包含的目录称为 >目录。 我建议在您的情况下，如果您在 System.IO.Path 的上下文中使用，则 projectPath 最符合此命名法。 然后，我将文件的名称称为 fileName，并将其包含的目录称为 parentDirectory。

Answer 4

我认为对此没有达成共识，只是尽量保持一致。

.NET Framework 中的示例：

• FileStream(string path...);

• Assembly.LoadFrom(string assemblyFile)

• XmlDocument.Load(string filename)

甚至文件名的大小写 (filename / fileName) 在框架中不一致，eg:

• FileInfo.CopyTo(string destFileName)

Answer 5

您应该在它可能包含的文件之后为其命名，即：

system_configuration_file_URI
user_input_file_URI
document_template_file_URI

“文件”或“文件名”否则大多无用

此外，“文件”可能意味着“我是一个文件点”，这是不明确的，“文件名”则不然说明它是否具有上下文（即：目录），fileURI 是上下文明确的，因为它表示“这是一个资源标识符，当观察时，它指向一个资源（文件）”

Answer 6

一些想法：

• projectFile 可能不是一个字符串——它可能是一个表示文件解析内容的对象。
• projectFileName 可能不是完全限定的。 如果文件实际上是“D:\Projects\MyFile.csproj”，则可能会包含“MyFile.csproj”。
• projectPath 可能被视为文件的完全限定路径，也可能被视为包含该文件的父文件夹的名称。
• projectFolder 可能被视为保存父文件夹的名称，或者它实际上可能是代码中某种 Folder 抽象的实现。

.NET 有时使用path 来引用文件，有时使用filename。

Answer 7

请注意，“文件名”在英语中是一个单词！ 标识符中间的“n”不需要大写。

也就是说，我将 Filename 附加到包含文件名的所有字符串变量中。 但是，我尝试避免整个场景，转而在支持文件和目录类型的语言中使用强类型变量。 毕竟，这就是可扩展类型系统的用途。

在强类型语言中，通常不需要描述性后缀（尤其是在函数参数中），因为变量类型和用法可以推断其内容。

Answer 8

所有这些都部分取决于方法的大小以及变量是否是类变量。

如果它们是类变量或在大型复杂方法中，请遵循 Kent Fredric 的建议，并将它们命名为指示文件用途的名称，即“projectFileName”。

如果这是一个小型实用程序方法，例如删除文件，则不要将其命名为“projectFileName”。 那么就简单地称其为“文件名”。

我永远不会将其命名为“路径”，因为这意味着它指的是它所在的文件夹。

将其称为“文件”就可以了，如果< /b> 没有其他变量，例如“fileID”或“filePtr”。

因此，我将使用“文件夹”或“路径”来标识文件所在的目录。

并使用“fileID”来表示文件对象。

最后，“文件名”是文件的实际名称。

快乐编码，
兰迪

Answer 9

根据上述选项的含义不明确且没有广泛接受的名称的答案，如果这是请求文件位置的 .NET 方法，则在 XML 注释中指定您想要的内容以及示例，如下所示如果其他开发人员不确定您想要什么，他们可以参考该内容。