代码之家  ›  专栏  ›  技术社区  ›  Max Schmeling

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

  •  7
  • Max Schmeling  · 技术社区  · 15 年前

    我想使用正确的术语使我的API尽可能直观,所以当一个参数被期望是完整的路径和文件名(例如“c:\users\max\documents\mydocument.txt”)时,正确的术语是什么?

    • 文件名-那就是mydocument.txt,对吗?
    • 路径-这只是C:\users\max\documents,对吗?

    参数名应该使用什么?“文件”是合适的名称吗?

    我觉得问这个有点傻,但我想确定它是对的。

    7 回复  |  直到 14 年前
        1
  •  2
  •   David Koelle    15 年前

    正确的术语是“完全限定名”(有时是“FQN”)。

    在API中应该使用的术语是“qualifiedname”或“qualifiedfilename”

    维基百科有一个条目 Fully qualified file name 并将其定义为“完全指定确切名称的计算机上的一个文件,这样它就不会含糊不清,也不会被误认为是该系统上的任何其他文件。”

        2
  •  3
  •   Zuu    15 年前

    我的建议是 “绝对文件路径” 对于指向文件的某些路径,我将使用“绝对目录路径”作为指向目录的路径

    在相对路径的情况下,变化应该是明显的。

    如果没有其他内容,您可以在文档中创建一个部分,描述您使用的某些术语的含义。

        3
  •  0
  •   iandisme    15 年前

    一个经常被过度使用的术语是 URI 尽管你的例子不是真的。我想如果你只使用“filepath”或“pathname”,你会非常清楚的。

    例如,Java的文件对象使用“路径名”作为其构造函数的参数名。 File 对象。

        4
  •  0
  •   slebetman    15 年前

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

    在许多示例代码中,您会看到人们编写: C:\path\to\the\document.txt

        5
  •  0
  •   slayerIQ    15 年前

    我会使用完整路径,就像你说的路径是C:\users\max\documents,但是读取完整路径会建议路径+文件名。

        6
  •  -1
  •   benzado    15 年前

    我不认为有一个真正的答案,也许是一些共识,但这就是我们所希望的。我通常尝试遵循我正在使用的库的约定(例如,COCOA、Java或PHP)。如果我什么都没有,我会说:

    • 文件:由名称引用的抽象对象:文件句柄
    • 路径:表示文件或目录位置的字符串,可以是绝对的,也可以是相对的: /Users/Max/Documents/FooBar , ../Sibling/Zardoz
    • 名称:文件或目录的名称,没有位置: FooBar , Zardoz , Documents
        7
  •  -1
  •   Chris S    14 年前

    您可能已经考虑过的一个更简单的解决方案是告诉API的使用者XML文档中的预期内容,如果用文档编译程序集并分发.xml文件,XML文档也将出现在Visual Studio IntelliSense中。

    /// <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)
    {
    
    }