手动添加文档注释让原本没有文档注释的dll库在使用时显示代码提示

问题来源

百度贴吧 - unity3d吧

帖子：【编程解疑】对Unity&C#编程遇到困难的请进

楼层：21楼

问题：

“大神你看这是.NET的API函数对吧？它在VS当中有函数提示，不知道有没有什么方法能让unity的API也显示类似的提示呢？”

配图：

文档注释的概念

C# 提供一种机制，使程序员可以使用含有 XML 文本的特殊注释语法为他们的代码编写文档。在源代码文件中，具有某种格式的注释可用于指导某个工具根据这些注释和它们后面的源代码元素生成 XML。使用这类语法的注释称为文档注释 (documentation comment)。这些注释后面必须紧跟用户定义类型（如类、委托或接口）或者成员（如字段、事件、属性或方法）。XML 生成工具称作文档生成器 (documentation generator)。（此生成器可以但不一定必须是 C# 编译器本身。）由文档生成器产生的输出称为文档文件 (documentation file)。文档文件可作为文档查看器 (documentation viewer) 的输入；文档查看器是用于生成类型信息及其关联文档的某种可视化显示的工具。

最关键的是文档注释与Visual Stdio 本身的代码智能感知系统无缝集成了。从而在编写C#代码时，Visual Studio能自动提示XML注释信息。

C#中XML文档注释编译DLL引用到其它项目后看不到，怎么办？

这个不是编写的问题，编译类库的时候需要把xml给提出来。
步骤：对工程点右键，选择属性，然后选择生成选项卡，输出下面把xml文档文件勾上，然后再生成下，你就会发现你的生成目录中有个xml文件，使用dll文件时，需要这个xml文件和DLL文件处于同一目录，就能得到提示了。 

手工编辑文档文件案例

首先新建名叫UnityEngine.xml的xml文件：

<?xml version="1.0"?>
<doc>
	<assembly>
		<name>UnityEngine</name>
	</assembly>
	<members>
		<member name="T:UnityEngine.Vector3">
			<summary>
				<para>表达三维向量和坐标点。</para>
				<para>这个结构在整个Unity中用于传递三维位置以及方向。同时它也包含了一些用于常规向量运算的函数。</para>
            </summary>
		</member>
		<member name="T:UnityEngine.Debug">
			<summary>
			一个包含了许多调试方法的类，方便游戏开发过程中的调试。
            </summary>
		</member>
		<member name="M:UnityEngine.Vector3.#ctor(System.Single,System.Single,System.Single)">
			<summary>
            使用指定的x, y, z分量创建三维向量
            </summary>
			<param name="x">
            x分量
            </param>
			<param name="y">
            y分量
            </param>
			<param name="z">
            z分量
            </param>
		</member>
	</members>
</doc>

如图所示：

然后将该文件存放于Unity3d安装根目录下的Editor\Data\Managed文件夹下，如下图所示：

效果展示

UnityEngine.Debug类的提示：

UnityEngine.Vector3类的提示：

UnityEngine.Vector3的构造函数的提示：

UnityEngine.Vector3的构造函数的各个参数的提示：