Quelle est la méthode recommandée pour empaqueter une bibliothèque de classes (DLL) C #?

Question

Je crée une bibliothèque de classes C # à utiliser par d'autres développeurs. Comment dois-je l’emballer - il suffit de compresser la DLL et de la placer sur le site Web?

Answer 1

La méthode recommandée consiste à télécharger la source de code, y compris les scripts de génération, vers un site Web tel que googlecode afin que les autres développeurs puissent le télécharger et le compiler, mais si elle est fermée, la bibliothèque source zippée de l'assemblage (mylibrary.DLL), la documentation (mylibrary.XML) et le fichier d'informations de débogage (mylibrary.PDB) devraient suffire.

Answer 2

S'il ne s'agit que d'une DLL, je ne voudrais pas la zipper. Cependant, ce serait bien si vous aviez compressé de la documentation avec un exemple de fichier de configuration, le cas échéant.

Answer 3

Eh bien, avez-vous déjà utilisé un autre tiers? Que voudriez-vous voir dans le téléchargement tiers parfaitement emballé?

Je le zippe avec le texte suivant au minimum:

• votre dll dans un dossier / bin /
• readme (txt ou html) expliquant ce que c'est, comment installer et où obtenir plus d'informations

si vous incluez la source alors * source dans / source / folder * Tous les tests dans un dossier / tests /

Si c'est quelque chose de bien, vous voudrez peut-être utiliser le code Google ou le codeplex plutôt que votre propre site?

Answer 4

Oui.

Vous devez inclure la documentation dans votre fichier ZIP, y compris un lien vers votre site Web. NDoc est idéal pour générer de la documentation à partir de vos commentaires XML.

Answer 5

Inspirez-vous des projets de tiers, mais une dll compressée suffit.

Si votre documentation est volumineuse, vous devez l'insérer dans un fichier zip séparé. Si vous publiez le code source, vous devez l'insérer dans un troisième fichier.

Dans tous les cas, votre dll devrait être accompagnée d’un fichier Lisez-moi, décrivant sa version, son objectif, son auteur et la manière de le contacter, ainsi que ses éventuelles dépendances et autres extraits utiles.

La documentation est vraiment importante!

Answer 6

Je suggérerais que, s'il s'agit d'un produit, vous souhaitiez un projet d'installation qui l'installe. Ceci inclurait le placer dans le GAC et laisser la documentation quelque part.

modifier

Juste pour clarifier, je parle de vraie documentation, pas seulement de ce qui est généré automatiquement à partir de commentaires.