VS 查看引用的DLL/Nuget包源码时,无法看到注释

2023-07-29,,

一、问题描述

在下面的截图中,我们发现,源码有添加一段注释

然后通过Nuget包引用,在VS中用Reshaper反编译时,发现没有注释:

原来,DLL是默认不带注释的。即你生成一个DLL,给另一个项目引用,使用时看不到原有的注释。

二、解决方案

那如何将原有注释显示出来?可以在项目属性-生成-输出菜单下,勾选“XML 文档文件”选项。

勾选后,在项目的文件列表中会自动生成xml文件:

重新打Nuget包并引用时,你也会发现,在nuget的lib文件夹下,多了份xml文件:

这样,使用DLL/Nuget包时,就有注释显示了。

另外 ,添加xml注释输出后,会提示开发人员补充代码注释:

三、其它问题

如果引用的Nuget包,还是没有注释。可以看下是否.NET版本原因,要把输出的TargetFramework都要加上xml才行

VS 查看引用的DLL/Nuget包源码时,无法看到注释的相关教程结束。

《VS 查看引用的DLL/Nuget包源码时,无法看到注释.doc》

下载本文的Word格式文档,以方便收藏与打印。