Was ist der empfohlene Weg, eine C # Klassenbibliothek (DLL) zu verpacken?
https://stackoverflow.com/questions/1228614
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianFrage
Ich schaffe eine C # Klassenbibliothek für die Verwendung von anderen Entwicklern. Wie soll ich es verpacken - nur die DLL-zip und es auf der Website setzen
Lösung
Die empfohlene Methode ist die Code-Source-Skripten auf eine Website bauen einschließlich hochladen wie Google so dass andere Entwickler es herunterladen konnte und es kompilieren, aber wenn es Closed-Source-Bibliothek ist die Baugruppe (MyLibrary.dll) zippen, Dokumentation (mylibrary.XML) und Debug-Informationsdatei (mylibrary.PDB) sollte ausreichen.
Andere Tipps
Wenn es nur eine DLL ist, dann würde ich nicht die Mühe, es zu zippen. Allerdings wäre es schön, wenn Sie mit ihm eine Dokumentation zip haben zusammen mit einer Beispielkonfigurationsdatei, falls zutreffend.
Nun, haben Sie jemals eine andere dritte Partei ein verwendet? Was möchten Sie in dem perfekt verpackt Dritten Download sehen?
Ich würde es mit den folgenden in mindestens Reißverschluss:
- Ihre DLL in / bin / Ordner
- readme (txt oder html) zu erklären, was es ist, wie zu installieren und wo weitere Informationen erhalten
Wenn Sie die Quelle incl dann * Quelle in / Quelle / Ordner * Alle Tests in einem / Tests / Ordner
Wenn sein etwas Gutes möchten Sie vielleicht dabei bleiben bis auf Google Code oder CodePlex anstatt Ihrer eigenen Website?
Ja.
Sie sollten Dokumentation in Ihrer ZIP-Datei enthalten, einschließlich eines Links auf Ihre Website zurück. NDoc ist groß für die Erzeugung Dokumentation von XML-Kommentare.
Blick auf 3rd-Party-prijects für Inspiration, aber ja, ein Zip-dll ist in Ordnung.
Wenn Sie Ihre Dokumentation groß ist, dann sollten Sie es in einen separaten Reißverschluss setzen, und wenn Sie die Quelle Freigabe sollten Sie, dass in einen dritten zip setzen.
In beiden Fällen sollten Sie Ihre DLL kommt mit einer Readme beschreiben, welche Version es ist, was der Zweck ist, wer es geschrieben hat und wie man mit ihnen in Kontakt zu treten, zusammen mit irgendwelchen Abhängigkeiten oder andere nützliche Schnipsel von Informationen.
Die Dokumentation ist wirklich wichtig!
Das würde ich vorschlagen, wenn dies ein Produkt ist, würden Sie ein Setup-Projekt mögen, die es installiert. Dies würde es im GAC platzieren und verlassen Dokumentation irgendwo.
Bearbeiten
Nur um zu klären, ich echte Dokumentation bedeuten, nicht nur, was von den Kommentaren automatisch generiert wird.
