WEB开发网
开发学院软件开发C语言 Sandcastle入门:创建C#帮助文档 阅读

Sandcastle入门:创建C#帮助文档

 2009-04-21 08:26:04 来源:WEB开发网   
核心提示: DocProject drives the Sandcastle help generation tools using the power of Visual Studio 2005/2008 and MSBuild生成文档步骤前提:代码文档中使用规范的///注释,具体规范查看MSDN-

DocProject drives the Sandcastle help generation tools using the power of Visual Studio 2005/2008 and MSBuild

生成文档步骤

前提:代码文档中使用规范的///注释,具体规范查看MSDN-建议的文档注释标记(C#编程指南)。也可以参看本人另一篇介绍文章:《C#中的XML注释》。

5.0 使用命令行方式

参考文章:Ref[7]

——使用sandcastle自带的例子test.cs来生成CHM文件

==========================================================================

1.在命令行下打开该文档所在的路径。例如:

cd \Program Files\Sandcastle\Examples\Sandcastle

2.编译该C#文件,并从中抽取///注释:/t参数使得其编译为dll文件,/doc参数使得其同时生成包含///注释的comments.xml文档。

csc /t:library /doc:comments.xmltest.cs

3.运行MrefBuilder生成中间文件reflection.org

MRefBuilder test.dll /out:reflection.org

4.运行XslTransform将上述中间文件转换成xml格式(vs2005)(瑶瑶按:使用prototype请参阅Ref[7]原文)

XslTransform. /xsl:"..\..\ProductionTransforms\ApplyVSDocModel.xsl" reflection.org /xsl:"..\..\ProductionTransforms\AddFriendlyFilenames.xsl" /out:reflection.xml

5.生成主题清单

XslTransform. /xsl:..\..\ProductionTransforms\ReflectionToManifest.xsl reflection.xml /out:manifest.xml

6.生成输出目录结构(vs2005)

call ..\..\Presentation\vs2005\copyOutput.bat

7.运行BuildAssembler生成HTML主题文件

BuildAssembler /config:sandcastle.config manifest.xml

上一页  1 2 3 4  下一页

Tags:Sandcastle 入门 创建

编辑录入:爽爽 [复制链接] [打 印]
赞助商链接