c# - 打包 C# 类库 (DLL) 的推荐方法是什么？

Question

我正在创建一个供其他开发人员使用的 C# 类库。我应该如何打包它 - 只需压缩 DLL 并将其放在网站上？

score 1 · Accepted Answer

如果它只是一个 DLL，那么我不会费心压缩它。但是，如果您确实压缩了一些文档以及示例配置文件（如果适用），那就太好了。

score 1 · Accepted Answer

推荐的方法是将包含构建脚本的代码源上传到网站，例如googlecode，以便其他开发人员可以下载并编译它，但如果它是封闭源库压缩程序集 (mylibrary.DLL)、文档 (mylibrary.XML ) 和调试信息文件 (mylibrary.PDB) 应该足够了。

score 0 · Accepted Answer

好吧，你有没有用过另一个第三方的？您希望在完美打包的第三方下载中看到什么？

我至少会用以下内容压缩它：

如果您包含源，则 * /source/ 文件夹中的源 * /tests/ 文件夹中的任何测试

如果它的东西很好，你可能想把它贴在谷歌代码或 codeplex 上而不是你自己的网站上？

score 0 · Accepted Answer

是的。

您应该在 ZIP 文件中包含文档，包括返回您网站的链接。NDoc 非常适合从您的 XML 注释生成文档。

score 0 · Accepted Answer

查看 3rd 方项目以获取灵感，但是是的，压缩 dll 很好。

如果您的文档很大，则应将其放入单独的 zip 中，如果您发布源代码，则应将其放入 3rd zip 中。

无论哪种方式，您的 dll 都应该附带一个自述文件，描述它是什么版本、目的是什么、谁编写了它以及如何与它们取得联系，以及任何依赖项或其他有用的信息片段。

文档真的很重要！

score 0 · Accepted Answer

我建议，如果这是一个产品，你会想要一个安装项目来安装它。这包括将其放在 GAC 中并将文档留在某处。

编辑

澄清一下，我的意思是真正的文档，而不仅仅是从评论中自动生成的内容。

6 回答 6