Ich erstelle eine C# -Klassenbibliothek für andere Entwickler. Wie sollte ich es zusammenpacken - einfach die DLL-Datei komprimieren und auf die Website stellen?Wie wird die C# -Klassenbibliothek (DLL) empfohlen?
Die empfohlene Methode besteht darin, die Quellcodequelle einschließlich Buildskripts auf eine Website wie googlecode hochzuladen, damit andere Entwickler sie herunterladen und kompilieren können, aber wenn es sich um eine geschlossene Quellbibliothek handelt, zippen die Assembly (mylibrary.DLL) (mylibrary.XML) und Debug-Informationsdatei (mylibrary.PDB) sollte ausreichen.
Wenn es sich um eine geschlossene Quelle handelt, bin ich nicht sicher, ob Sie die XML- und PDB-Dateien versenden würden. –
Wenn es nur eine DLL ist, würde ich nicht stören, es zu zippen. Es wäre jedoch nett, wenn Sie eine Dokumentation mit diesem zusammen mit einer Beispielkonfigurationsdatei zippen würden.
Nun, haben Sie schon einmal eine dritte verwendet? Was möchten Sie im perfekt verpackten Third-Party-Download sehen?
Ich würde es Reißverschluss mit der mindestens folgendes:
erhalten, wenn Sie die Quelle incl dann * Quelle in/Quelle/Ordner * Alle Tests in einem/Tests/Ordner
Wenn es etwas Gutes ist, möchtest du es lieber auf Google Code oder Codeplex als auf deiner eigenen Website speichern?
Ja.
Sie sollten die Dokumentation in Ihre ZIP-Datei einfügen, einschließlich eines Links zurück zu Ihrer Website. NDoc eignet sich hervorragend zum Generieren von Dokumentationen aus Ihren XML-Kommentaren.
Schauen Sie sich 3rd Party Prjects für die Inspiration, aber ja, eine gezippte DLL ist in Ordnung.
Wenn Ihre Dokumentation groß ist, sollten Sie sie in einen separaten Zip legen, und wenn Sie die Quelle freigeben, sollten Sie diese in einen 3. Zip stecken.
Wie auch immer Ihre DLL sollte mit einer Readme, die beschreibt, welche Version es ist, was der Zweck ist, wer es geschrieben hat und wie man mit ihnen, zusammen mit irgendwelchen Abhängigkeiten oder anderen nützlichen Schnipsel von Informationen zu kontaktieren.
Dokumentation ist sehr wichtig!
Ich würde vorschlagen, dass, wenn dies ein Produkt ist, Sie ein Setup-Projekt möchten, das es installiert. Dies würde beinhalten, es in den GAC zu legen und die Dokumentation irgendwo zu belassen.
bearbeiten
Nur um zu klären, ich meine wirkliche Dokumentation, nicht nur, was automatisch von den Kommentaren erzeugt wird.
Tipp: Verpacken Sie es mit einem funktionierenden, einfachen C# -Beispiel (d. H. Mit einem Beispiel ein zusätzliches Projekt in der Bibliothekslösung). Ihre Benutzer werden es Ihnen danken. – Brian