Я создаю библиотеку классов C# для использования другими разработчиками. Как мне его упаковать - просто запустите библиотеку DLL и поместите ее на сайт?Каков рекомендуемый способ упаковки библиотеки классов C# (DLL)?
Рекомендованный способ - загрузить источник кода, включая скрипты сборки, на веб-сайт, например googlecode, чтобы другие разработчики могли его загрузить и скомпилировать, но если он закрыт исходной библиотекой, застегивающей сборку (mylibrary.DLL), документация (mylibrary.XML) и файл отладочной информации (mylibrary.PDB) должно быть достаточно.
Если это закрытый источник, я не уверен, что вы отправляете файлы XML и PDB. –
Если это просто DLL, то я бы не стал заморачиваться. Однако было бы неплохо, если бы вы закрепили какую-то документацию вместе с примерным файлом конфигурации, если это применимо.
Ну, вы когда-нибудь использовали другой третья сторона? Что бы вы хотели увидеть в абсолютно упакованной третьей стороне?
Я бы пронестись его следующее в как минимум:
, если вы в том числе источник затем * источник в/источник/папки * Любые испытания в/тесты/папки
Если его что-то хорошее, вы можете захотеть придерживаться его в коде Google или кодексе, а не на своем собственном сайте?
Да.
Вы должны включить документацию в свой ZIP-файл, включая ссылку на ваш сайт. NDoc отлично подходит для создания документации из ваших комментариев XML.
Посмотрите на сторонние prijects для вдохновения, но да, сглаженная dll в порядке.
Если ваша документация большая, вы должны поместить ее в отдельный почтовый индекс, и если вы освободите источник, вы должны поместить его в третий почтовый индекс.
В любом случае ваша dll должна поставляться с readme, описывающим, какая версия это, какая цель, кто ее написал и как связаться с ними, а также любые зависимости или другие полезные фрагменты информации.
Документация действительно важна!
Я бы предположил, что если это продукт, вам нужен проект установки, который его устанавливает. Это будет включать размещение его в ПКК и где-то оставить документацию.
редактировать
Просто чтобы прояснить, я имею в виду реальную документацию, а не только то, что автоматически генерируемый от комментариев.
Совет. Упакуйте его рабочим, простым примером C# (т. Е. Выполните дополнительный проект внутри решения библиотеки с примером). Ваши пользователи будут вам благодарны. – Brian