当然,Visual Studio 中有一种项目可以输出人们可以使用的 DLL。我知道。我只是想知道开发人员在使用我的 DLL 文件时会期望哪些标准。
我将提供一个在 IMDB 中搜索电影并返回结果供开发人员使用的类。
不是网络服务,而是本地 DLL 文件。(我知道 IMDB 对网络抓取不满意,但我也知道他们会在被要求时给予人们许可。我的许可已经发送。)
我应该如何处理这个?
查看 Microsoft 的类库开发人员设计指南。
或相同的更新版本(感谢paper1337
)。
然后,您对设计类库时的最佳实践感兴趣。这个主题有很多话要说。
您需要做的首要事情之一是发布所有依赖项。避免代码中的任何隐藏依赖项。
例如,不要依赖于在共享键值集合中设置某些键,例如 Session。您图书馆的用户无法找到它。
如果某些方法需要预先初始化某些服务,则需要将有效引用作为参数传递。
您至少需要提供一个简单易用的 API、完整的文档和工作示例。如果您可以提供单元测试,那将是一个奖励。
在内部,您需要验证例程中的所有输入,并清楚地记录用户期望执行的配置。可靠的异常处理是给定的,您可能还应该考虑其中的一些本地化支持。
如果您或任何人认真想为其他人使用创建一个好的框架,请查看http://www.amazon.com/Framework-Design-Guidelines-Conventions-Libraries/dp/0321246756
无论您公开什么,都应该保持公开,并且他们的签名不能在您的下一个版本中更改,您必须永远支持它。
因此,请注意建立您的合同并用示例记录它们。仅在需要时才公开成员。