Как я могу сообщить разработчику моего интерфейса, что параметр «путь» представляет собой папку?

Question

Я собираюсь определить интерфейс в моем приложении, который могут использовать плагины для обеспечения пользовательских «экспортных» возможностей. Это будет выглядеть примерно так:

public interface IFooExporter 
{ 
    void ExportFoo(Foo foo, string path); 
} 

Однако, мне нужно, чтобы плагин писатели знает (в явном виде, а не только в документации), что «путь» представляет собой папку, а не имя файла. Их ответственность заключается в создании файлов как части процесса экспорта.

Каков наилучший способ обеспечить, чтобы путь был папкой, а не именем файла? Моя догадка прямо сейчас использовать DirectoryInfo вместо строки:

public interface IFooExporter 
{ 
    void ExportFoo(Foo foo, DirectoryInfo folder); 
} 

Это хорошее решение, или есть подводные камни, я не в курсе с передачей экземпляров DirectoryInfo вокруг?

Answer 1

Поскольку вы не внедряете решение, я согласен с вами в решении использовать DirectoryInfo в качестве параметра. Если вы укажете строку, нет способа остановить переданную строку.

Answer 2

Используйте комментарии XML, они появятся в всплывающем окне Visual Studio Intellisense.

/// <summary> 
/// Type in the text you want to appear 
/// </summary> 

Answer 3

Назовите свою переменную более явно. Это просто путь? Вы говорите, что это не так, но вы все равно оставляете его с общим именем. Назовите его folderPath и будет меньше путаницы и меньше нужно явно сообщать об этом исполнителям.