XML注释文档
合集下载
相关主题
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
1.名词解释：Sandcastle
======================================================================== Documentation compilers for managed class libraries Enabling managed class library developers throughout the world to easily create accurate, informative documentation with a common look and feel.
* 磨刀不误砍柴工
* [Android源码分析]从spec角度 来详细分析inquiry command带 来的影响
* Linux下使用虚拟网卡的 ingress流控(入口流控)
* 使用Node.js完成的第一个项 目的实践总结
最新评论
让postgresql支持存储过程(函数) piaoyubohe: 4）make5）make install没有啊 有个Makefile 文件 如何安装？
SQL Server2005 与 SQL S(1e5r0ve3r)
C#中dataGrid的批量更新 (984)
在winform中，MDI窗体不能(打706)
在Winform中，获取DataGrid(668)
postgresql 导出数据
(401)
CSDN2013年度博客之星评选 文思海辉第一届在线编程大赛 华内容 办公大师系列经典丛书 诚聘译者
MrefBuilder完成工作后，立即由Build Assembler接手处理。Build Assembler可由命令行工具BuildAssembler 启动。它利用由MrefBuilder生成的数据(reflection.xml)和任何代码注释（保存在独立的XML文件中），生成按逻 辑分组的HTML文件。HTML Help Compiler再利用这些HTML文件生成最终结果。
3.Sandcastle Overview
Sandcastle是一个管理类库的文档编译器，是用于编译发布组件（Assembly）信息的一个工具，这个工具通 过反射和Xslt技术，可以从dll文件及其xml注释（命令行编译时加/doc参数或vs2005设置项目属性得到）得到一个 完整的帮助文档，格式可以是Html或CHM甚至是任何自定义的格式。（Ref[2]，Ref[3]，有增删整合）
消灭0回答，赢下载分
订阅CSDN社区周刊，及时了解社区精
Sandcastle入门：创建C#帮助文档
分类： .net
2008-04-02 15:19
3342人阅读
c#
documentation
文档
chm
xml
html
评论(5) 收藏 举报
Sandcastle入门：创建C#帮助文档
今天学到了一个东西：利用vs2005生成的dll/xml来生成帮助文档。 完成这个伟大任务的是Sandcastle，微软推出的类库文档编译工具。 在开始这篇笔记之前，我想先感谢我文后提及的七篇关于Sandcastle的文章。是它们出色的阐述使得我能够 整理出这篇笔记，之前我从未接触过。对于那七篇文章，我努力寻找它们的源出处链接，然而网络的传播性使得 这些一再被转载的文章逐渐模糊了它们的来源，有一些是我无法确定的。因此，我希望，如果这篇文章有幸能被 您转载，请注明转载和出处，谢谢。o(∩_∩)o…
然而遗憾的是，这 个项目由于资金等问题，作者Kevin于2006年7月宣布不再投入NDoc开源项目的开发，NDoc停留在1.3的历史版 本，无法完全支持.NET 2.0，将渐渐淡出人们的视野。
在发布VS2005之前，MS内部开发了一个用于生成帮助文档的工具。这就是Sandcastle的前身。但是当时编 译一次文档就需要十多个钟头，这使得这个工具可用性不强。后来发布的Sandcastle由于做了很大的优化，就只 要30分钟了。当然，现在的Sandcastle经历了几个CTP版本的测试已经比较成熟了。（Ref[1]，有增删）（注： CTP，Community Technology Preview）。Sandcastle目前（2007年10月30日）为止最新的版本是September 2007 CTP，version 2.3.07930.06，2007年10月1日发布。（瑶瑶按：在写这篇日志的过程中，MS发布了新的 Sandcastle版本October 2007 CTP，version 2.3.8000.26，2007年10月29日发布。相应地后面提到的 SandcastleGUI也进行了更新。）
发布ASP.NET应用程序时 (376) (334)
评论排行
Sandcastle入门：创建C#
让postgresql支持存储过程 (5)
Hibernate延迟加载
(4)
C#读取properties文件
(1)
JSP中的pageEncoding和 (1)
使用J2SE1.4开发CORBA (0)
让跨浏览器测试 Web 应
Sandcastle入门：创建C#帮助文 匿名用户: 还不错，就是没有具体 的细节啊？
Sandcastle入门：创建C#帮助文 billsoff: 好文！
让postgresql支持存储过程(函数) chclvzxx: 4）make5）make install没有啊 有个Makefile 文件 如何安装？
Hibernate延迟加载 shayebu: 高手能不能帮俺做一下 属性延时加载的实例呀！
2.Background
在微软推出Sandcastle之前，人们倾向于选择开源的NDoc（.NET代码文档生成器）。NDoc可以将 C#.NET 编译生成的程序集和对应的 /doc XML文档，自动转换成如 .NET Framework SDK 类库文档或者 MSDN Library 在线 .NET 类库文档形式的代码文档：
Sandcastle与.NET Framework 2.0和.NET Compact Framework组合使用。Sandcastle支持本地化，并提供 一个基本的命令行编译器界面和一个Visual Studio插件。（Ref[2]） 4.Sandcastle Process（Ref[2]）
Sandcastle中共有三个组件：MrefBuilder、Build Assembler和XslTransform。这些工具使用编译汇编代码时 生成的输出结果，包括DLL文件以及XML注释文件。
该工具并未限制你一次处理一个汇编。如果你需要处理几个汇编代码，你必须深入了解Sandcastle配置文 件。它是一个包含建立帮助文件主题所需步骤的XML文件。
http://blog.csdn.net/greatwallmy/article/details/2245204
2013-12-11 星期三
Sandcastle入门：创建C#帮助文档 - greatwallmy的专栏 - 博客频道 - CSDN.NET Page 3 of 9
(0)
linux上安装postgresql
(0)
useradd:cannot rewrite shadow(0)
配置tomcat访问日志
(0)
(0)
推荐文章
* ruby三日游之后（一）—— Ruby对象的一次探索
* 使用ViewPager+Fragment来实 现带滚动条的多屏滑动IndicatorFragmentActivity
4.1 使用平台 4.2 使用方式（可选界面） 4.3 资源下载 5. 生成文档步骤------------------------------------------------[3] 5.0 使用命令行方式 5.1 Sandcastle Help File Builder 5.2 SandcastleGUI 5.3 Sandcastle CHM编译BAT脚本和配置实用工具 5.4 DocProject 6. References----------------------------------------------------[3] ========================================================================
(瑶瑶按：由于本文较长且从word移植到baidu的诸多不便，本文将分成3个部分分别发布）
目录 ======================================================================== 1. 名词解释：Sandcastle---------------------------------------[1] 2. Background---------------------------------------------------[1] 3. Sandcastle Overview-----------------------------------------[1] 4. 使用Sandcastle-----------------------------------------------[2]
文章存档
2009年04月 (2) 2009年03月 (4) 2009年02月 (1) 2008年12月 (2) 2008年09月 (2)
阅读排行
C#读取properties文件
Sandcastle入门：创建C# (4365)
webservice中返回多个返回(3341)
让postgresql支持存储过程(1691)
MrefBuilder反射一个项目的汇编代码并生成一个输出文件。MrefBuilder是一个随Sandcastle安装的命令行工 具。它生成的输出文件通过XslTransform命令行工具转换成一个叫做reflection.xml的文件。reflection.xml文件包 含所有文档数据，但不提供显示细节。
C#读取properties文件 ignite_spark: 请问下你的 properties文件是怎样的格式，我 怎么读取的不对啊,能给个 properties文件的...
Sandcastle入门：创建C#帮助文 liwenonline: 就会在该项目下看到 HTML版和CHM版的文档看不到 html版本的啊
访问： 21541次 积分： 423分 排名： 千里之外 原创： 15篇 转载： 21篇 译文： 1篇 评论： 11条
文章搜索
文章分类
.net (14) codesmith (0) java (6) Linux (1) SQL (1) UML (0) WebService (1) 数据库 (3) 虚拟机 (1)
Sandcastle入门：创建C#帮助文 stoneniqiu: 步骤多的蛋疼
让postgresql支持存储过程(函数) taovslong: window 下要装 pldebugger怎么办？
让postgresql支持存储过程(函数) id0096: 若在postgresql-8.4 以上 版本安装的时候需要修改 edbdebugger里 的几个文件...
SandcastlLeabharlann Baidu入门：创建C#帮助文档 - greatwallmy的专栏 - 博客频道 - CSDN.NET Page 1 of 9
首页 业界 移动 云计算 研发 论坛 博客 下载 更多
您还未登录！| 登录 | 注册 | 帮助
greatwallmy的专栏
目录视图
摘要视图
订阅
个人资料
greatwallmy
Sandcastle生成的输出结果具有以下特点：
（图：Sandcastle工作过程）
========================================================================
http://blog.csdn.net/greatwallmy/article/details/2245204
2013-12-11 星期三
Sandcastle入门：创建C#帮助文档 - greatwallmy的专栏 - 博客频道 - CSDN.NET Page 2 of 9
======================================================================== Documentation compilers for managed class libraries Enabling managed class library developers throughout the world to easily create accurate, informative documentation with a common look and feel.
* 磨刀不误砍柴工
* [Android源码分析]从spec角度 来详细分析inquiry command带 来的影响
* Linux下使用虚拟网卡的 ingress流控(入口流控)
* 使用Node.js完成的第一个项 目的实践总结
最新评论
让postgresql支持存储过程(函数) piaoyubohe: 4）make5）make install没有啊 有个Makefile 文件 如何安装？
SQL Server2005 与 SQL S(1e5r0ve3r)
C#中dataGrid的批量更新 (984)
在winform中，MDI窗体不能(打706)
在Winform中，获取DataGrid(668)
postgresql 导出数据
(401)
CSDN2013年度博客之星评选 文思海辉第一届在线编程大赛 华内容 办公大师系列经典丛书 诚聘译者
MrefBuilder完成工作后，立即由Build Assembler接手处理。Build Assembler可由命令行工具BuildAssembler 启动。它利用由MrefBuilder生成的数据(reflection.xml)和任何代码注释（保存在独立的XML文件中），生成按逻 辑分组的HTML文件。HTML Help Compiler再利用这些HTML文件生成最终结果。
3.Sandcastle Overview
Sandcastle是一个管理类库的文档编译器，是用于编译发布组件（Assembly）信息的一个工具，这个工具通 过反射和Xslt技术，可以从dll文件及其xml注释（命令行编译时加/doc参数或vs2005设置项目属性得到）得到一个 完整的帮助文档，格式可以是Html或CHM甚至是任何自定义的格式。（Ref[2]，Ref[3]，有增删整合）
消灭0回答，赢下载分
订阅CSDN社区周刊，及时了解社区精
Sandcastle入门：创建C#帮助文档
分类： .net
2008-04-02 15:19
3342人阅读
c#
documentation
文档
chm
xml
html
评论(5) 收藏 举报
Sandcastle入门：创建C#帮助文档
今天学到了一个东西：利用vs2005生成的dll/xml来生成帮助文档。 完成这个伟大任务的是Sandcastle，微软推出的类库文档编译工具。 在开始这篇笔记之前，我想先感谢我文后提及的七篇关于Sandcastle的文章。是它们出色的阐述使得我能够 整理出这篇笔记，之前我从未接触过。对于那七篇文章，我努力寻找它们的源出处链接，然而网络的传播性使得 这些一再被转载的文章逐渐模糊了它们的来源，有一些是我无法确定的。因此，我希望，如果这篇文章有幸能被 您转载，请注明转载和出处，谢谢。o(∩_∩)o…
然而遗憾的是，这 个项目由于资金等问题，作者Kevin于2006年7月宣布不再投入NDoc开源项目的开发，NDoc停留在1.3的历史版 本，无法完全支持.NET 2.0，将渐渐淡出人们的视野。
在发布VS2005之前，MS内部开发了一个用于生成帮助文档的工具。这就是Sandcastle的前身。但是当时编 译一次文档就需要十多个钟头，这使得这个工具可用性不强。后来发布的Sandcastle由于做了很大的优化，就只 要30分钟了。当然，现在的Sandcastle经历了几个CTP版本的测试已经比较成熟了。（Ref[1]，有增删）（注： CTP，Community Technology Preview）。Sandcastle目前（2007年10月30日）为止最新的版本是September 2007 CTP，version 2.3.07930.06，2007年10月1日发布。（瑶瑶按：在写这篇日志的过程中，MS发布了新的 Sandcastle版本October 2007 CTP，version 2.3.8000.26，2007年10月29日发布。相应地后面提到的 SandcastleGUI也进行了更新。）
发布ASP.NET应用程序时 (376) (334)
评论排行
Sandcastle入门：创建C#
让postgresql支持存储过程 (5)
Hibernate延迟加载
(4)
C#读取properties文件
(1)
JSP中的pageEncoding和 (1)
使用J2SE1.4开发CORBA (0)
让跨浏览器测试 Web 应
Sandcastle入门：创建C#帮助文 匿名用户: 还不错，就是没有具体 的细节啊？
Sandcastle入门：创建C#帮助文 billsoff: 好文！
让postgresql支持存储过程(函数) chclvzxx: 4）make5）make install没有啊 有个Makefile 文件 如何安装？
Hibernate延迟加载 shayebu: 高手能不能帮俺做一下 属性延时加载的实例呀！
2.Background
在微软推出Sandcastle之前，人们倾向于选择开源的NDoc（.NET代码文档生成器）。NDoc可以将 C#.NET 编译生成的程序集和对应的 /doc XML文档，自动转换成如 .NET Framework SDK 类库文档或者 MSDN Library 在线 .NET 类库文档形式的代码文档：
Sandcastle与.NET Framework 2.0和.NET Compact Framework组合使用。Sandcastle支持本地化，并提供 一个基本的命令行编译器界面和一个Visual Studio插件。（Ref[2]） 4.Sandcastle Process（Ref[2]）
Sandcastle中共有三个组件：MrefBuilder、Build Assembler和XslTransform。这些工具使用编译汇编代码时 生成的输出结果，包括DLL文件以及XML注释文件。
该工具并未限制你一次处理一个汇编。如果你需要处理几个汇编代码，你必须深入了解Sandcastle配置文 件。它是一个包含建立帮助文件主题所需步骤的XML文件。
http://blog.csdn.net/greatwallmy/article/details/2245204
2013-12-11 星期三
Sandcastle入门：创建C#帮助文档 - greatwallmy的专栏 - 博客频道 - CSDN.NET Page 3 of 9
(0)
linux上安装postgresql
(0)
useradd:cannot rewrite shadow(0)
配置tomcat访问日志
(0)
(0)
推荐文章
* ruby三日游之后（一）—— Ruby对象的一次探索
* 使用ViewPager+Fragment来实 现带滚动条的多屏滑动IndicatorFragmentActivity
4.1 使用平台 4.2 使用方式（可选界面） 4.3 资源下载 5. 生成文档步骤------------------------------------------------[3] 5.0 使用命令行方式 5.1 Sandcastle Help File Builder 5.2 SandcastleGUI 5.3 Sandcastle CHM编译BAT脚本和配置实用工具 5.4 DocProject 6. References----------------------------------------------------[3] ========================================================================
(瑶瑶按：由于本文较长且从word移植到baidu的诸多不便，本文将分成3个部分分别发布）
目录 ======================================================================== 1. 名词解释：Sandcastle---------------------------------------[1] 2. Background---------------------------------------------------[1] 3. Sandcastle Overview-----------------------------------------[1] 4. 使用Sandcastle-----------------------------------------------[2]
文章存档
2009年04月 (2) 2009年03月 (4) 2009年02月 (1) 2008年12月 (2) 2008年09月 (2)
阅读排行
C#读取properties文件
Sandcastle入门：创建C# (4365)
webservice中返回多个返回(3341)
让postgresql支持存储过程(1691)
MrefBuilder反射一个项目的汇编代码并生成一个输出文件。MrefBuilder是一个随Sandcastle安装的命令行工 具。它生成的输出文件通过XslTransform命令行工具转换成一个叫做reflection.xml的文件。reflection.xml文件包 含所有文档数据，但不提供显示细节。
C#读取properties文件 ignite_spark: 请问下你的 properties文件是怎样的格式，我 怎么读取的不对啊,能给个 properties文件的...
Sandcastle入门：创建C#帮助文 liwenonline: 就会在该项目下看到 HTML版和CHM版的文档看不到 html版本的啊
访问： 21541次 积分： 423分 排名： 千里之外 原创： 15篇 转载： 21篇 译文： 1篇 评论： 11条
文章搜索
文章分类
.net (14) codesmith (0) java (6) Linux (1) SQL (1) UML (0) WebService (1) 数据库 (3) 虚拟机 (1)
Sandcastle入门：创建C#帮助文 stoneniqiu: 步骤多的蛋疼
让postgresql支持存储过程(函数) taovslong: window 下要装 pldebugger怎么办？
让postgresql支持存储过程(函数) id0096: 若在postgresql-8.4 以上 版本安装的时候需要修改 edbdebugger里 的几个文件...
SandcastlLeabharlann Baidu入门：创建C#帮助文档 - greatwallmy的专栏 - 博客频道 - CSDN.NET Page 1 of 9
首页 业界 移动 云计算 研发 论坛 博客 下载 更多
您还未登录！| 登录 | 注册 | 帮助
greatwallmy的专栏
目录视图
摘要视图
订阅
个人资料
greatwallmy
Sandcastle生成的输出结果具有以下特点：
（图：Sandcastle工作过程）
========================================================================
http://blog.csdn.net/greatwallmy/article/details/2245204
2013-12-11 星期三
Sandcastle入门：创建C#帮助文档 - greatwallmy的专栏 - 博客频道 - CSDN.NET Page 2 of 9