Sandcastle是一個管理類庫的文檔編譯器,是用于編譯發(fā)布組件(Assembly)信息的一個工具,這個工具通過反射和Xslt技術,可以從dll文件及其xml注釋(命令行編譯時加/doc參數(shù)或vs2005設置項目屬性得到)得到一個完整的幫助文檔,格式可以是Html或CHM甚至是任何自定義的格式。
【中組件】
MrefBuilder、Build Assembler和XslTransform。這些工具使用編譯匯編代碼時生成的輸出結(jié)果,包括DLL文件以及XML注釋文件。
MrefBuilder反射一個項目的匯編代碼并生成一個輸出文件。MrefBuilder是一個隨Sandcastle安裝的命令行工具。它生成的輸出文件通過XslTransform命令行工具轉(zhuǎn)換成一個叫做reflection.xml的文件。reflection.xml文件包含所有文檔數(shù)據(jù),但不提供顯示細節(jié)。
MrefBuilder完成工作后,立即由Build Assembler接手處理。Build Assembler可由命令行工具BuildAssembler啟動。它利用由MrefBuilder生成的數(shù)據(jù)(reflection.xml)和任何代碼注釋(保存在獨立的XML文件中),生成按邏輯分組的HTML文件。HTML Help Compiler再利用這些HTML文件生成最終結(jié)果。
該工具并未限制你一次處理一個匯編。如果你需要處理幾個匯編代碼,你必須深入了解Sandcastle配置文件。它是一個包含建立幫助文件主題所需步驟的XML文件。
【andcastle生成的輸出結(jié)果特點】
1、類似于MSDN布局的界面。
2、自動生成索引項、內(nèi)容項目表、主題塊和頁面布局,提高一致性和熟悉程度。
3、自動生成語法宣稱部分。
4、自動生成繼承表。
5、代碼彩色化。
6、提供多種風格和語言選擇,終端用戶可從中選擇自己最喜歡的形式。
7、輸出結(jié)果以HTML和CSS形式顯示,微軟承諾將來提供更多選擇。



































