[转]Sandcastle初探——官方版的NDoc
Sandcastle初探——官方版的NDoc
Sandcastle(CodeName)是微软出的用于编译发布组件(Assembly)信息的一个工具,基本上等同于NDoc(后者目前已经停止开发,最新版本仍然不支持.Net 2.0)。这个工具通过反射和Xslt技术,可以从dll文件及其xml注释(编译时加/doc参数得到),得到一个完整的帮助文档,格式可以是Html或CHM甚至是任何自定义的格式。当前Sandcastle最新版本是June CTP。使用方式仍然是命令行,而官方网站上给出的使用说明只能支持单一的Dll,也就是Project,对于Solution仍然没有任何说明。其Blog上介绍说以后会有GUI和VS.Net 2005 Add-In等使用方式。现在让我们来先睹为快。
Sandcastle June CTP的下载地址http://www.microsoft.com/downloads/details.aspx?FamilyID=e82ea71d-da89-42ee-a715-696e3a4873b2&DisplayLang=en,如果你需要编译生成CHM文档,还需要HTML Help Workshop,下载地址http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp
以上两个文件的安装很简单,一直点击下一步就可以成功安装。安装时强烈建议使用默认的路径。
编译文档的方法有两种,一种是使用我写的Bat文件(前提是安装使用的是默认路径),下载地址/Files/yuandong/sandcastlebuild.rar:使用方法如下:
1. 下载并安装Sandcastle和HTML Help Workshop,使用默认路径。
2. 点这里下载编译文件,解压缩。包含三个文件:build.bat,build.config,build.hhp。
3. 将以上三个文件拷贝到Project的bin的Debug目录下。(假设要编译的组件名成为Assembly,确定目录下至少包含Assembly.dll和Assembly.xml,后者为XML注释。如何产生XML注释参见http://msdn2.microsoft.com/zh-CN/library/b2s063f7.aspx )
4. 开一个CMD,导航到Debug目录。
5. 键入“build 组件名”上例中即为“Build Assembly”。
6. 生成的文件在Debug的Output目录下。
以下为我生成的CHM的截图:
Output
下的“组件名+Html”目录下为Html格式的文件,名称使用的是GUID,一般来说大小最小的为首页,复制一个,改名为Index.htm就可以发布了。以下为Html的截图:
请注意上图最低部的版权信息:“(c) It.ouc.edu.cn. All rights reserved. Send comments about this topic to yuandong1222@gmail.com.”此信息从C:\Program Files\Sandcastle\Presentation\Content\shared_content.xml里面设置(默认是微软)。
从截图中可以看到,Sandcastle对中文的支持很好,而且生成的默认格式是我们再熟悉不过的MSDN风格。
注意,以上方法只适合没有依赖的组件,对于有依赖的组件,需要修改Bat文件,详细方法在Bat文件中有详细的注释。
第二种编译的方法是官方发布的方法,详情参看https://blogs.msdn.com/sandcastle/archive/2006/07/29/682398.aspx,E文很简单,我就不翻译了。这种方法比较麻烦,有问题的可以留言讨论。
从以上介绍可以看出,Standcastle的编译生成已经很成熟了,而且从分析来看,其可定执行相当强大。只是使用方法还很简陋,离实际使用还有距离,毕竟还是CTP版本。不过相信微软的东西,最终易用性应该是让人满意的。更多内容可以参考:
https://blogs.msdn.com/sandcastle/default.aspx
http://forums.microsoft.com/MSDN/ShowForum.aspx?ForumID=66&SiteID=1
或留言讨论。
[转]Sandcastle初探——官方版的NDoc相关推荐
- 谷歌官方版android,谷歌Android 11正式官方版
谷歌Android 11正式官方版终于和广大用户朋友们见面了,今天,谷歌正式发布了最新版本的移动操作系统Android 11,此次更新为大家新增了很多的功能,分别分为三个主题,人. 控件和隐私.And ...
- 下载oracle修复补丁下载,Oracle数据库修复工具下载_FROMBYTE Reconstructor for Oracle官方版下载[修复软件]-下载之家...
FROMBYTE Reconstructor for Oracle(Oracle数据库修复工具)官方版是一款专为Oracle的数据库进行修复软件,可以通过Oracle数据库修复工具软件创建 ...
- linux拓实n87驱动下载,拓实n87网卡驱动for xp/win7官方版
拓实n87网卡驱动for xp/win7官方版是一个十分强大的网卡驱动管理软件,拓实n87网卡驱动for xp/win7官方版是ts N87高增益全向无线USB网卡驱动程序,拓实n87全面支持移动cm ...
- 程序安装包制作工具 v1.0官方版
2019独角兽企业重金招聘Python工程师标准>>> 名称:程序安装包制作工具 v1.0官方版 版本:1.0更新日期:2016-06-27 大小:2.9MB软件语言:简体中文 软件 ...
- cleanmymac3.9.6下载_单耳兔o2oapp下载-单耳兔o2o商城官方版下载v10.6 安卓版
单耳兔o2o商城官方版是一款非常强大的线上o2o平台.成熟的互联网电商.完全免费开店.帮助用户进行更好的平台推广.产多商品可供自由选择.支持各种支付方式.一键分享开店.让更多的人推广销售,创造双赢.利 ...
- 安卓市场官方版_尖端实用的安卓手机APP推荐 是你们想要的!
hello,大家好,欢迎收看本期的精品应用集推荐,本公众号专注黑科技神器&石皮解软件分享!时过境迁,推荐的有些神器可能失效了,用到挂既可!关注APP精品集公众号不定期推送新版本,所以每日的神器 ...
- 天龙固件U盘更新_硅格T18D量产工具下载_硅格T18D量产工具官方版下载[u盘格式化]...
硅格T18D量产工具官方版是比较实用的u盘修复工具,硅格T18D量产工具官方版可以让使用者很轻松便捷的对硅格T18D进行量产操作,并支持修复和格式化的功能,提高U盘的性能,释放空间.硅格T ...
- python3.6安装包-Python3.6.6官方版
Python3.6.6官方版是一种功能强大,轻量便捷的计算机程序设计语言,它也是一种功能强大而完善的通用型语言,成熟且稳定.Python3.6.6官方版具有非常简捷而清晰的语法特点,适合完成各种高层任 ...
- python3-Python3.7.0官方版
Python3.7.0官方版是一种相当靠谱和出众的通用型语言.Python3.7.0官方版被广泛使用,提供了丰富全面的模块,并支持sockets编程,可以非常方便快速地开发分布式应用程序,同时还有PI ...
最新文章
- redchat怎么编写shell脚本_shell脚本编写思路
- matlab2010alinux下载,Linux matlab 2010a 下载与安装过程
- web开发入门到深入-WebAssembly(1)
- java中静态变量,静态代码块,静态方法,实例变量,匿名代码块的加载顺序
- html选项卡_UltraEdit文字编辑何使用选项卡式子窗口教程
- Javascript——声明提升(函数、变量提升)
- arcgis javascript api 事件的监听及移除
- 计算机内存断点,计算机 | 码农们都需要知道的「中断」相关知识
- shell编程:笔记*
- JMeter的编码与HTTP请求
- 蓝桥杯2020山西省省赛太原理工大获丰收
- 在四位共阴极数码上显示“2 3 5 8”四个数字
- 腾讯优图贾佳亚:当AI进入产业应用时代时,计算机视觉技术更应该服务于人才对!
- 华为认证HCNE考试知识点
- 模型实践 | Alphafold 蛋白质结构预测
- div是什么意思?HTML和CSS中div标签怎么用
- 使用proteus仿真集成运放构成的三角波发生电路
- 设置美团用户cookie实现用户登录
- Qt图表绘制(QtCharts)-绘制简单的盒须图[箱形图](12)
- 主键约束(PRIMARY KEY, PK)