Question

我想使用正确的术语使我的API尽可能直观，所以当一个参数应该是一个完整的路径和文件名（ex“C：\ Users \ Max \ Documents \ MyDocument.txt”）时是正确的术语吗？

filename - 那只是MyDocument.txt，对吧？
路径 - 那就是C：\ Users \ Max \ Documents，对吧？

我应该将什么用于参数名称？ “file”会是合适的名字吗？

我觉得有点愚蠢地问这个，但我想确保它是正确的。

Answer 1

对于某个指向文件的路径，我的建议是“绝对文件路径”，而对于指向目录的路径，我会使用“绝对目录路径”

如果是相对路径，变化应该是显而易见的。

如果不出意外，您可以随时在文档中创建一个描述您使用的某些术语含义的部分。

Answer 2

正确的术语是“完全合格的名称”（有时是“FQN”）。

您应在API中使用的术语是“QualifiedName”或“QualifiedFilename”

Wikipedia有一个“Fully qualified file name”条目，并将其定义为“计算机上的文件，其名称已完全指定，因此它是明确的，不会被误认为该系统上的任何其他文件。” / p>

Answer 3

一个经常被过度使用的术语是URI，尽管你的例子实际上不是其中之一。如果你只使用“filepath”或“pathname”，我想你会非常清楚。

例如，Java的文件对象使用“pathname”作为其File对象上构造函数的参数名称。

Answer 4

通常路径是完整的C:\Users\Max\Documents\MyDocument.txt，而C:\Users\Max\Documents\部分通常称为基本目录或只是目录。

您会在很多示例代码中看到：C:\path\to\the\document.txt

Answer 5

我会选择fullPath，就像你说路径是C：\ Users \ Max \ Documents但读完fullPath会建议路径+文件名。

Answer 6

我认为没有一个真正的答案，也许是一些共识，但这是我们所能希望的。我通常会尝试遵循我正在使用的库的约定（例如，Cocoa，Java或PHP）。如果我什么都没有，我会说：

文件：名称引用的抽象事物：文件句柄
路径：一个字符串，指示文件或目录的位置，绝对或相对：/Users/Max/Documents/FooBar，../Sibling/Zardoz
名称：文件或目录的名称，不包含位置：FooBar，Zardoz，Documents

Answer 7

您可能已经考虑过的一个更简单的解决方案是告诉消费者API文档中需要什么，如果您使用文档编译程序集，并且分发.xml文件，它也会出现在Visual Studio intellisense中。 / p>

/// <summary>
/// Saves the provided file to disk.
/// </summary>
/// <param name="filePath">The full path, including the filename of the file.</param>
public void SaveFile(string filePath)
{

}

引用路径和文件名的正确术语是什么？

7 个答案: