¿Cuál es el término correcto para referirse a una ruta y un nombre de archivo?

Question

Quiero utilizar el término correcto para hacer que mi API sea lo más intuitiva posible, de modo que cuando se espera que un parámetro sea una ruta de acceso completa y un nombre de archivo (por ejemplo, "C: \ Users \ Max \ Documents \ MyDocument.txt") el término correcto?

• nombre de archivo - eso sería simplemente MyDocument.txt, ¿verdad?
• ruta - eso solo sería C: \ Users \ Max \ Documents, ¿no?

¿Qué debo usar para el nombre del parámetro? ¿Sería "archivo" el nombre apropiado?

Me siento un poco tonto al preguntar esto, pero quiero asegurarme de que sea correcto.

Answer 1

El término correcto es "nombre completo de" (a veces "FQN").

El término se debe utilizar en su API es "QualifiedName" o "QualifiedFilename"

Wikipedia tiene una entrada para "Fully qualified file name" y lo define como "un archivo en un equipo cuyo nombre exacto se especifica completamente de tal manera que no es ambiguo y no se puede confundir con ningún otro archivo en ese sistema ".

Answer 2

Un término usado a menudo para esto es URI, aunque su ejemplo no es realmente uno de esos. Creo que estarás perfectamente claro si solo usas "filepath" o "pathname".

Por ejemplo, el objeto de archivo de Java utiliza "ruta de acceso" como el nombre del parámetro para el constructor en su objeto File.

Answer 3

Por lo general, la ruta es la C:\Users\Max\Documents\MyDocument.txt completa, mientras que la parte C:\Users\Max\Documents\ suele conocerse como el directorio base o solo el directorio.

Usted verá en una gran cantidad de personas de código de ejemplo escribe: C:\path\to\the\document.txt

Answer 4

No creo que haya una sola respuesta verdadera, tal vez un consenso, pero eso es todo lo que podemos desear. Normalmente trato de seguir las convenciones de la biblioteca que estoy usando (por ejemplo, Cocoa, Java o PHP). Si no tengo nada que pasar, yo diría:

• Archivo: lo abstracto se refiere a un nombre: el archivo de manejar
• Path: una cadena que indica la ubicación de un archivo o directorio, ya sea absoluta o relativa: /Users/Max/Documents/FooBar, ../Sibling/Zardoz
• nombre: el nombre del archivo o directorio, sin ubicación: FooBar, Zardoz, Documents

Answer 5

me gustaría ir con fullPath como usted ha dicho camino sería C : \ Users \ M ax \ Documents pero leyendo fullPath sugeriría path + filename.

Answer 6

Mi sugerencia sería "ruta de archivo absoluta" por alguna ruta que apunta a un archivo, en tanto que, lo usaría "ruta de directorio absoluto" para una ruta que apunta a un directorio

En el caso de las rutas relativas al el cambio debería ser obvio.

Si nada más, siempre puede hacer una sección en su documentación donde describa el significado de ciertos términos que utiliza.

Answer 7

Una solución más fácil que puede haber considerado ya le está diciendo al consumidor de la API lo que se espera en la documentación XML, que también aparecerá en Visual Studio intellisense si compila el ensamblado con documentación y distribuye el archivo .xml.

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

}