Каков рекомендуемый способ упаковки библиотеки классов C # (DLL)? - PullRequest
Новая
       6

Каков рекомендуемый способ упаковки библиотеки классов C # (DLL)?

2 голосов
/ 04 августа 2009

Я создаю библиотеку классов C # для использования другими разработчиками. Как мне его упаковать - просто заархивируйте DLL и разместите на сайте?

Ответы [ 6 ]

1 голос
/ 04 августа 2009

Рекомендованный способ - загрузить исходный код, включая сценарии сборки, на веб-сайт, такой как googlecode , чтобы другие разработчики могли загрузить его и скомпилировать, но если это закрытая библиотека исходных текстов, архивируем сборку .DLL), документации (mylibrary.XML) и файла отладочной информации (mylibrary.PDB) должно быть достаточно.

1 голос
/ 04 августа 2009

Если это просто DLL, я бы не стал ее архивировать. Однако было бы неплохо, если бы вы применили к нему некоторую документацию вместе с образцом файла конфигурации, если это применимо.

0 голосов
/ 04 августа 2009

Я бы предположил, что если это продукт, вам нужен проект установки, который его устанавливает. Это будет включать размещение его в GAC и где-нибудь оставлять документацию.

редактировать

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

0 голосов
/ 04 августа 2009

Посмотрите на сторонние темы для вдохновения, но да, архивированный dll в порядке.

Если ваша документация велика, вы должны поместить ее в отдельный zip-архив, а если вы выпускаете исходный код, вы должны поместить его в 3-й zip.

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

Документация действительно важна!

0 голосов
/ 04 августа 2009

Да.

Вы должны включить документацию в свой ZIP-файл, включая ссылку на ваш сайт. NDoc отлично подходит для создания документации из ваших комментариев XML.

0 голосов
/ 04 августа 2009

Ну, вы когда-нибудь использовали другой сторонний? Что бы вы хотели видеть в прекрасно упакованном пакете сторонних разработчиков?

Я бы застегнул это как минимум:

  • ваша dll в папке / bin /
  • readme (txt или html), объясняющий, что это такое, как установить и где получить дополнительную информацию

если вы включаете источник, то * источник в / source / папке * Любые тесты в папке / tests /

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

...