Menu
I want to use the correct term to make my API as intuitive as possible, so when a parameter is expected to be a full path and filename (ex "C:\Users\Max\Documents\MyDocument.txt") what is the correct term?
What should I use for the parameter name? Would "file" be the appropriate name?
I feel kind of dumb asking this, but I want to make sure it's right.
911
The set of names required to specify a particular file in a hierarchy of directories is called the path to the file, which you specify as a path name. Path names are used as arguments for commands.
To write a path that moves into a folder we specify the folder name, followed by a forward slash, then the file name.
A file name is a name a particular inode is called inside a particular directory. A path is some instructions for how to reach an inode from a known point.
pathname. / (ˈpɑːθˌneɪm) / noun. computing the name of a file or directory together with its position in relation to other directories traced back in a line to the root; the names of the file and each of the parent directories are separated from one another by slashes.
My suggestion would be "Absolute file path" for some path pointing to a file, where as i would use "Absolute directory path" for a path pointing to a directory
In case of relative paths the change should be obvious.
If nothing else, you can always make a section in your documentation where you describe the meaning of certain terms you use.
171
The correct term is "Fully Qualified Name" (sometimes "FQN").
The term you should use in your API is "QualifiedName" or "QualifiedFilename"
Wikipedia has an entry for "Fully qualified file name" and defines it as "a file on a computer whose exact name is completely specified such that it is unambiguous and cannot be mistaken for any other file on that system."
44
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
