Какой правильный термин для обозначения пути и имени файла?

Question

Я хочу использовать правильный термин, чтобы сделать мой API как можно более интуитивно понятным, поэтому, когда ожидается, что параметром будет полный путь и имя файла (например, «C: \ Users \ Max \ Documents \ MyDocument.txt»), что правильный термин?

• имя файла - это будет просто MyDocument.txt, верно?
• путь - это просто C: \ Users \ Max \ Documents, верно?

Что я должен использовать для имени параметра? Будет ли «файл» подходящим именем?

Я чувствую себя глупо, спрашивая это, но я хочу убедиться, что это правильно.

Answer 1

Мое предложение будет "Абсолютный путь к файлу" для некоторого пути, указывающего на файл, где, как я бы использовал "Абсолютный путь к каталогу" для пути, указывающего на каталог

В случае относительных путей изменение должно быть очевидным.

Если ничего другого, вы всегда можете сделать раздел в своей документации, где вы описываете значение определенных терминов, которые вы используете.

Answer 2

Правильный термин «Полное имя» (иногда «FQN»).

Термин, который вы должны использовать в своем API, - «QualifiedName» или «QualifiedFilename»

В Википедии есть запись для " Полностью определенное имя файла " и определяет его как "файл на компьютере, точное имя которого полностью указано так, что оно однозначно и не может быть ошибочно принято за любой другой файл на эта система. "

Answer 3

Одно более простое решение, которое вы, возможно, уже рассмотрели, - это рассказать потребителю API, что ожидается в XML-документации, которая также появится в Visual Studio intellisense, если вы скомпилируете сборку с документацией и распространите файл .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)
{

}

Answer 4

Я бы пошел с fullPath, как вы сказали, что путь будет C: \ Users \ Max \ Documents, но чтение fullPath предложит путь + имя файла.

Answer 5

Я не думаю, что есть Один Истинный Ответ, возможно, некоторый консенсус, но это все, на что мы можем надеяться. Я обычно стараюсь следовать соглашениям библиотеки, которую я использую (например, Какао, Java или PHP). Если мне нечего пройти, я бы сказал:

• Файл: абстрактная вещь, на которую ссылается имя: дескриптор файла
• Путь: строка, указывающая местоположение файла или каталога, абсолютное или относительное: /Users/Max/Documents/FooBar, ../Sibling/Zardoz
• Имя: имя файла или каталога без местоположения: FooBar, Zardoz, Documents

Answer 6

Обычно путь - это полный C:\Users\Max\Documents\MyDocument.txt, тогда как часть C:\Users\Max\Documents\ обычно называется базовым каталогом или просто каталогом.

Вы увидите много примеров кода, которые пишут люди: C:\path\to\the\document.txt

Answer 7

Термин, часто используемый для этого, - URI , хотя ваш пример на самом деле не один из них. Я думаю, вам будет совершенно ясно, если вы просто используете «filepath» или «pathname».

Например, файловый объект Java использует «путь» в качестве имени параметра для конструктора в их файле объекте.