程序的注釋在程序的編寫和維護(hù)中扮演著相當(dāng)重要的角色,在Visual C#中,可以為代碼創(chuàng)建文檔,方法是在XML標(biāo)記所指的代碼塊前面,直接在源代碼的特殊注釋字段中包括XML 標(biāo)記。編譯器編譯時(shí)將在源代碼中搜索所有的 XML 標(biāo)記,并創(chuàng)建一個(gè)XML文檔文件。.NET文檔生成工具(下文簡(jiǎn)稱為ADB)通過(guò)反射程序集及其代碼中的XML注釋來(lái)創(chuàng)建MSDN形式的API文檔。
1.ADB2.3的功能特性:
(1)根據(jù)程序集及其對(duì)應(yīng)的XML文檔文件生成風(fēng)格類似MSDN的文檔,并打包為CHM文件;
(2)將多個(gè)程序集對(duì)應(yīng)的文檔合并到一個(gè)文檔中;
(3)自動(dòng)搜索程序集及其引用的程序集對(duì)應(yīng)的XML文檔(包括.Net自帶的程序集,如:System.xml);
(4)靈活控制在文檔中顯示哪些成員(如:只生成公共方法);
(5)界面友好,操作簡(jiǎn)便。
(6)用戶可以根據(jù)自己的需要擴(kuò)展XML標(biāo)志;
(7)用戶可以根據(jù)自己的需要編寫自定義的文檔生成器。