Thuật ngữ chính xác để đề cập đến đường dẫn và tên tệp là gì?

Question

Tôi muốn sử dụng cụm từ chính xác để làm cho API của mình trực quan nhất có thể, vì vậy khi tham số được mong đợi là một đường dẫn đầy đủ và tên tệp (ví dụ: C: \ Users \ Max \ Documents \ MyDocument.txt ") thuật ngữ chính xác?

• tên tệp - đó chỉ là MyDocument.txt, đúng không?
• đường dẫn - đó chỉ là C: \ Users \ Max \ Documents, phải không?

Tôi nên sử dụng cái gì cho tên thông số? "Tệp" có phải là tên thích hợp không?

Tôi cảm thấy ngớ ngẩn khi hỏi điều này, nhưng tôi muốn đảm bảo điều đó đúng.

Answer 1

Thuật ngữ đúng là "Fully Qualified Name" (đôi khi "FQN").

Thuật ngữ mà bạn nên sử dụng trong API của bạn là "QualifiedName" hoặc "QualifiedFilename"

Wikipedia có một mục nhập cho "Fully qualified file name" và định nghĩa nó là "một tập tin trên một máy tính có tên chính xác là hoàn toàn quy định như vậy nó rõ ràng và không thể nhầm lẫn với bất kỳ tệp nào khác trên hệ thống đó. "

Answer 2

Cụm từ thường bị lạm dụng cho điều này là URI, mặc dù ví dụ của bạn không thực sự là một trong số đó. Tôi nghĩ bạn sẽ hoàn toàn rõ ràng nếu bạn chỉ sử dụng "filepath" hoặc "pathname".

Ví dụ: đối tượng tệp của Java sử dụng "tên đường dẫn" làm tên thông số cho hàm tạo trên đối tượng File của chúng.

Answer 3

Đường dẫn thường là đầy đủ C:\Users\Max\Documents\MyDocument.txt trong khi phần C:\Users\Max\Documents\ thường được gọi là thư mục cơ sở hoặc chỉ thư mục.

Bạn sẽ thấy trong rất nhiều ví dụ mã của người viết: C:\path\to\the\document.txt

Answer 4

Tôi không nghĩ rằng có một câu trả lời thực sự, có thể một số đồng thuận, nhưng đó là tất cả những gì chúng tôi có thể hy vọng. Tôi thường cố gắng tuân theo các quy ước của thư viện mà tôi đang sử dụng (ví dụ: Cocoa, Java hoặc PHP). Nếu tôi đã có gì để đi theo, tôi muốn nói:

• File: điều trừu tượng được gọi bằng một cái tên: tập tin xử lý
• Đường dẫn: một chuỗi chỉ ra vị trí của một tập tin hoặc thư mục, hoặc là tuyệt đối hay tương đối: /Users/Max/Documents/FooBar, ../Sibling/Zardoz
• Name: tên của tập tin hoặc thư mục, không có vị trí: FooBar, Zardoz, Documents

Answer 5

tôi muốn đi với fullpath như bạn nói con đường sẽ là C : \ Users \ M rìu \ Tài liệu nhưng đọc fullPath sẽ đề xuất đường dẫn + tên tệp.

Answer 6

Đề nghị của tôi sẽ là "đường dẫn tập tin tuyệt đối" cho một số con đường trỏ đến một tập tin, nơi như tôi sẽ sử dụng "đường dẫn thư mục Absolute" cho một con đường trỏ đến một thư mục

Trong trường hợp đường dẫn tương đối thay đổi phải rõ ràng.

Nếu không có gì khác, bạn luôn có thể tạo một phần trong tài liệu của mình nơi bạn mô tả ý nghĩa của một số cụm từ bạn sử dụng.

Answer 7

Một giải pháp dễ dàng hơn bạn có thể đã xem xét là nói cho người tiêu dùng về API những gì được mong đợi trong tài liệu XML, cũng sẽ xuất hiện trong Visual Studio intellisense nếu biên dịch của bạn lắp ráp tài liệu và phân phối tệp .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) 
{ 

}