2016-10-26 6 views
1

В настоящее время я разрабатываю небольшой библиотечный модуль C# .dll для одного продукта моей компании. Это мой первый опыт разработки приложения, отличного от UWP, на C#, и я потерял способность эффективно распространять интерфейс для своей библиотеки.C# Эквивалентен файлу заголовка .h при распространении библиотеки .dll

В C++/C файлы заголовков распространяются вместе с библиотекой и заголовками библиотеки .dll как интерфейсы, которые пользователи взаимодействуют с программным обеспечением. Документация может быть предоставлена ​​отдельно или часто документация включена в файл заголовка.

В C# то, что я вижу чаще всего, заключается в том, что люди объявляли бы публичную информацию об открытых классах или методах (остальные объявлялись как внутренние или частные) и распространяли DLL с образцом проекта. Хотя типичного проекта обычно достаточно, когда пользователь хочет использовать менее известную функцию, ему или ей приходится прорываться через пространство имен или генерировать «файл заголовка» из метаданных, которые не имеют никакой документации.

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

+0

Ваши проблемы не ясны ... Возможно, вы ищете [Учебное пособие по XML-документации (C#)] (https://msdn.microsoft.com/en-us/library/aa288481 (v = vs.71). ASPX)? –

+0

@AlexeiLevenkov Я ищу эквивалент C# для файла C.h. для распространения с DLL-файлом. Хотя, если их нет, я думаю, что предоставление отдельной документации - это один из способов сделать это. – legokangpalla

+0

http://stackoverflow.com/questions/11814771/why-doesnt-c-sharp-have-header-files-will-the-namespace-take-care-of-everythin? Обратите внимание, что сложнее вводить в заблуждение типы в .Net, чем в заголовочном файле C (где вы можете скрыть много вещей ...) Разъясняя, почему вы считаете, что сборка сама по себе предоставляет меньше информации, чем файл .h может помочь ... Предположительно, вы не считаете .Net framework хорошим примером - поиск проекта, который достигает того, что вы ищете, - это еще один вариант. –

ответ

0

Нет эквивалента: поскольку у C# нет файлов заголовков, ссылок на них действительно нечего.

Вы хотите посмотреть документацию по XML, как это было предложено комментатором, - которые будут (с Visual Studio) давать всплывающие подсказки IDE, предлагающие детали реализации и позволяющие передавать похожие, если не более богатые данные.