C#生成带注释的dll并引用实现
时间:2022-11-20 10:13:43|栏目:.NET代码|点击: 次
一. 编写.cs文件
注:要想编译dll中注释可用,则代码中的注释要用“ /// ” 来进行注释,否则编译后注释不起作用。
注释是生成在XML文件中的。
ComputeDemo.cs:
using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; namespace MetaDataTest1 { /// <summary> /// 类名:ComputeDemo /// </summary> public class ComputeDemo { /// <summary> /// 加法 /// </summary> /// <param name="a"></param> /// <param name="b"></param> /// <returns></returns> public int Add(int a, int b) { return a + b; } /// 减法 public int Sub(int a, int b) { return a - b; } /// 乘法 public int Multi(int a, int b) { return a * b; } ///除法 public double Div(int a, int b) { return a / b; } } }
Program.cs:
using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; namespace MetaDataTest1 { class Program { static void Main(string[] args) { var obj = new ComputeDemo(); int addResult = obj.Add(1, 2); Console.WriteLine(addResult); Console.ReadKey(); } } }
二. 生成XML文件注释
在类库项目上,右键属性-生成-输出,勾选XML文档文件,选择文档名以及DLL文件输出的路径。如下图:
三. 打开MSBuild Command Prompt for VS2015生成dll文件
输入命令如下:
csc /t:library /out:D:\DllPath\MetaDataTest1.dll D:\ComputeDemo.cs
其中:/out:D:\DllPath\MetaDataTest1.dll 为生成输出的DLL路径和DLL文件
D:\ComputeDemo.cs 为.cs文件路径位置
则成功生成MetaDataTest1.dll文件(.dll文件命名要和.xml文件一致)
四. 使用另一个项目引用.dll文件
右击References- Add References – Browers 进行添加引用。查看注释是否存在,如下图所示:
查看DLL相关信息,如下图片所示: