程序的注释在程序的编写和维护中扮演着相当重要的角色,在Visual C#中,可以为代码创建文档,方法是在XML标记所指的代码块前面,直接在源代码的特殊注释字段中包括XML 标记。编译器编译时将在源代码中搜索所有的 XML 标记,并创建一个XML文档文件。.NET文档生成工具(下文简称为ADB)通过反射程序集及其代码中的XML注释来创建MSDN形式的API文档。
1.ADB2.3的功能特性:
(1)根据程序集及其对应的XML文档文件生成风格类似MSDN的文档,并打包为CHM文件;
(2)将多个程序集对应的文档合并到一个文档中;
(3)自动搜索程序集及其引用的程序集对应的XML文档(包括.Net自带的程序集,如:System.xml);
(4)灵活控制在文档中显示哪些成员(如:只生成公共方法);
(5)界面友好,操作简便。
(6)用户可以根据自己的需要扩展XML标志;
(7)用户可以根据自己的需要编写自定义的文档生成器。