unity3d-api-docs
C# XML Documentation Project for UnityEngine.dll and other libraries.
针对UnityEngine.dll等Unity3d标准库的 C# 版 XML 文档注释工程。
欢迎大家的加入！
使用方法
执行生成解决方案，将会在bin\Debug或者bin\Release目录成生成UnityEngine.xml等xml文件，将这些xml文件放置于Unity3d安装目录的Editor\Data\Managed等目录下，即可实现在Visual Studio、MonoDevelop编写代码时，出现代码提示，提示脚本开发人员。
例如： D:\Program Files\Unity\Editor\Data\Managed
不使用Visual Studio的玩家，可以使用项目根目录下的build.bat批处理脚本来生成dll与xml文件。生成的文件同样是在bin\Debug下。
效果展示
UnityEngine.Debug类的提示：
UnityEngine.Vector3类的提示：
UnityEngine.Vector3的构造函数的提示：
UnityEngine.Vector3的构造函数的各个参数的提示：
代码规范
因为不需要实现UnityEngine这个库，而只是想仿照UnityEngine的命名空间、类名组织结构，生成一个对应的XML文档注释输出文件，用于代码智能提示。 所以工程中类的方法实现相当于是个傀儡（dummy）。但是如果改成abstract则又改变了类的属性，与原始类库中的类不相匹配。因此制定此代码规范。
访问修饰符、命名空间、Attribute、方法原型（签名）等参考自Visual Studio对UnityEngine.dll等库的反编译（从元数据）。
返回类型为 void 的方法
方法体为空，什么也不做，具体写法为： { }
返回类型不为 void 的方法
方法体返回该值类型的默认值，具体的写法为：
{ return default(returntype); }
struct 的构造方法
因为当struct的构造方法含有参数时，如果用空函数体会报错，编译器认为有未初始化的字段。所以此处调用所有struct都有的无参构造函数，具体写法如下：
public StructTypeName(param1,param2,...): this() { }
也就避开了给该struct每个字段逐一赋值的多余操作。
out 修饰符修饰的方法参数
拥有 out 修饰的参数被编译器要求在离开方法前赋值。因此不得不在方法体内加上赋值语句，具体写法为：
{ outParam1 = default(outParam1Type); outParam2 = default(outParam2Type); ... }