我想使用正确的术语使我的API尽可能直观,所以当一个参数被期望是完整的路径和文件名(例如“C:\ Users \ Max \ Documents \ MyDocument.txt”)时,什么是正确的术语?引用路径和文件名的正确术语是什么?
- 文件名 - 这只是MyDocument.txt,对不对?
- path - 那只是C:\ Users \ Max \ Documents,对不对?
我应该用什么参数名称? “文件”会是合适的名称吗?
我觉得有点傻,问这个,但我想确保它是正确的。
我想使用正确的术语使我的API尽可能直观,所以当一个参数被期望是完整的路径和文件名(例如“C:\ Users \ Max \ Documents \ MyDocument.txt”)时,什么是正确的术语?引用路径和文件名的正确术语是什么?
我应该用什么参数名称? “文件”会是合适的名称吗?
我觉得有点傻,问这个,但我想确保它是正确的。
,正确的说法是“完全合格的名称”(有时“FQN”)。
您应该在API中使用的术语是“QualifiedName的”或“QualifiedFilename”
维基百科对“Fully qualified file name”的条目,并将其定义为“一个文件,其确切的名称是完全确定这样的计算机上它是明确的,不能被误认为是该系统上的任何其他文件。“
一般路径是全C:\Users\Max\Documents\MyDocument.txt
而C:\Users\Max\Documents\
部分通常被称为基本目录或只是目录。
你会在很多示例代码的人看到写:C:\path\to\the\document.txt
我不认为有一个真正的答案,也许一些共识,但这就是我们所希望的。我通常会尝试遵循我正在使用的库的约定(例如,Cocoa,Java或PHP)。如果我没有什么去了,我会说:
/Users/Max/Documents/FooBar
,../Sibling/Zardoz
FooBar
,Zardoz
,Documents
我与FULLPATH像你说的路径是C去:\用户\中号ax \ Documents但读取完整路径会建议路径+文件名。对于一些路径指向一个文件,其中我会用“绝对目录路径”为指向的目录
在相对路径的情况下的路径
我的建议是“绝对路径”的变化应该很明显。
如果没有其他内容,您可以随时在文档中对您使用的某些术语的含义进行描述。
您可能已经考虑过的一种更简单的解决方案是告诉API的使用者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)
{
}
+1 - 我喜欢你花时间让你的API变得直观。 – 2010-01-06 22:29:18
+1 ...如果你使用的是Java或C#,你总是可以踢,然后javadoc它。 – iandisme 2010-01-06 22:41:01
我会重复使用来自java.io.File的术语:absoluteFilePath – 2010-01-07 01:34:04