【发布时间】:2016-10-26 10:49:52
【问题描述】:
我目前正在为我公司的一个产品开发一个小型 C# .dll 库模块。这是我第一次用 C# 开发非 UWP 应用程序,我有点迷失如何有效地为我的库分发接口。
在 C++/C 中,头文件与 .dll 库一起分发,头文件作为用户与软件交互的接口。文档可以单独提供,或者文档通常包含在头文件中。
在 C# 中,我最常看到的是人们会在公开的类或方法上声明公共(其余声明为内部或私有)并使用示例项目分发 .dll。虽然一个示例项目通常就足够了,但当用户想要使用鲜为人知的功能时,他或她必须挖掘命名空间或从没有任何文档的元数据中生成“头文件”。
我想知道有经验的 C# 开发人员在这种情况下会怎么做。
【问题讨论】:
-
您的顾虑不清楚...也许您正在寻找XML Documentation Tutorial(C#)?
-
@AlexeiLevenkov 我正在寻找与 C .h 文件等效的 C# 文件,以便与 .dll 文件一起分发。虽然,如果没有,我想提供单独的文档是一种方法。
-
stackoverflow.com/questions/11814771/… ?请注意,在 .Net 中歪曲您的类型比在 C 头文件中更难(您可以在其中隐藏很多东西......)澄清为什么您认为程序集本身提供的信息少于 .h 文件可能会有所帮助......大概你不认为 .Net 框架是一个很好的例子 - 搜索实现你正在寻找的项目是另一种选择。
-
在C#中,DLL不仅仅是可执行代码,而且也是头文件。 .NET 程序集包含 元数据,即程序集中公共类型的描述。不需要做任何特别的事情,您的库的使用者只需添加对您的程序集的引用。相当于#include。编译器知道如何从 DLL 中读取元数据。
标签: c# dll header-files