软件下载 | 资讯教程 | 最近更新 | 下载排行 | 一键转帖 | 发布投稿
您的位置:最火下载站 > 网络编程 > ASP.NET > 使用SandCastle创建.Net帮助文档

使用SandCastle创建.Net帮助文档

Sandcastle是微软提供的一个根据XML注释和DLL文件生成帮助文件的工具,目前是在CodePlex上的一个开源项目,可以去这里下载:Sandcatle 项目
Sandcastle 本身是一个console的程序,为了方便使用,我们可以使用他的GUI版本:Sandcastle Help File Builder

软件名称: Sandcastle
软件版本: v2.6.1062
软件大小: 13MB
软件授权: 免费版本
适用平台: Win9X Win2000 WinXP Win2003 Vista Win7
下载地址:

第一步,为你写的代码添加XML注释

我们创建一个简单的ClassLibrary1项目最为示范:

Copy to ClipboardLiehuo.Net Codes引用的内容:[www.veryhuo.com]
using System;

using System.Collections.Generic;

using System.Text;



namespace ClassLibrary1

{

/// <summary>

/// A sample class to show something using Sandcastle

/// </summary>

public class SampleClass

{

private string _propertyValue;



/// <summary>

/// Gets or sets the property value.

/// </summary>

/// <value>The property value.</value>

public string Property

{

get

{

return _propertyValue;

}

set

{

_propertyValue = value;

}

}



/// <summary>

/// Determines whether the property is null.

/// </summary>

/// <returns>

/// <c>true</c> if property is null; otherwise, <c>false</c>.

/// </returns>

public bool IsPropertyNull()

{

bool result = false;



if (this.Property == null)

{

result = true;

}

return result;

}



/// <summary>

/// Determines whether the property is null.

/// </summary>

/// <returns>

/// <c>true</c> if property is empty; otherwise, <c>false</c>.

/// </returns>

/// <example>

/// This example shows how you might use this method:

///

/// <code>

/// SampleClass sample = new SampleClass();

///

/// if (sample.IsPropertyEmpty())

/// {

/// Console.WriteLine("The property is empty");

/// }

/// else

/// {

/// Console.WriteLine("The property contains value " + sample.Property);

/// }

/// </code>

/// </example>

public bool IsPropertyEmpty()

{



bool result = this.IsPropertyNull();



if (!result)

{

result = (Property.Trim().Length == 0);

}

return result;

}

}

}

代码很简单,注意其中的XML注释。

打开项目的属性,在“Build”选项中,确保“XML documentation file:”被选中了。

image

第二步,编译这个项目,你会看到生成的DLL文件和XMl文件:

image

第三步,打开 Sandcastle Help File Builder

打开Sandcastle Help File Builder并新建一个项目:

image

为Sandcastle Help File Builder项目添加编译生成的DLL文件,右键点击项目右边的“Documentation Sources",选择“Add Documentation Source...”

image

选择刚刚生成的DLL文件。

image

第四步,修改设置

在项目的属性窗口,你可以根据需要修改一些设置。

image

第五步,生成文档

image

点击Build the help file来生成文档。

这是最终生成的文档:

image

上一篇:在ASP.Net页尾添加JavaScript的最佳方法
下一篇:暂无文档
    相关阅读
    栏目导航
    推荐软件