文档章节

Sandcastle是微软提供的一个根据XML注释和DLL文件生成帮助文件的工具

李朝强
 李朝强
发布于 2015/08/14 13:31
字数 466
阅读 127
收藏 1

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

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

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

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:”被选中了。

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

第三步,打开 Sandcastle Help File Builder

第四步,修改设置

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

第五步,生成文档




本文转载自:http://www.cnblogs.com/DotNetNuke/archive/2009/04/23/1441899.html

李朝强
粉丝 91
博文 297
码字总数 149962
作品 0
郑州
产品经理
私信 提问
使用SandCastle创建.Net帮助文档

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

m2land
2009/04/23
0
0
微软官方的文档生成工具--Sandcastle

Sandcastle是微软官方的文档生成工具,NDoc开发停止后,这个貌似也是唯一的一个这方面的工具。它从dll文件及其xml注释文件能够生成完整的帮助文档,支持多种生成格式(Helpe1x:chm, Helper2x:...

匿名
2012/10/29
2.8K
0
四种Sandcastle方法生成帮助类帮助文档

方法一、Visual Studio新建documentation生成帮助文档 前段时间在网上收集和自己平时工作总结整理了《干货,比较全面的c#.net公共帮助类》,整理完成上传github之后我又想,既然是帮助类,总得...

安与生_
2017/10/18
0
0
.net 开发人员的十大必备工具之一

.net 开发人员的十大必备工具之一。 新版.Net开发必备十大工具 收藏 Snippet Compiler Snippet Compiler是一个基于 Windows 的小型应用程序,你可以通过它来编写、编译和运行代码。如果你具有...

黄双
2010/07/23
1K
3
1分钟生成Net对象的注释

我们在开发过程中,肯定会有几个项目作为基础项目,存放一些比较常用的类和方法,供其他项目使用.一般来说,方法实现以后,就不想再去管它了,以致于新加入的某个伙计问这个项目里的方法有没注释或...

小特工作室
2011/10/31
0
0

没有更多内容

加载失败,请刷新页面

加载更多

iOS Xcode升级包地址(感谢大神)

下载地址:DeviceSupport

_____1____
24分钟前
6
0
Qt编写自定义控件71-圆弧进度条

一、前言 现在web形式的图表框架非常流行,国产代表就是echart,本人用过几次,三个字屌爆了来形容,非常强大,而且易用性也非常棒,还是开源免费的,使用起来不要太爽,内置的各种图表和仪表...

飞扬青云
24分钟前
4
0
润乾报表与 ActiveReport JS 功能对比

简介 润乾报表是用于报表制作的大型企业级报表软件,核心特点在于开创性地提出了非线性报表数学模型,采用了革命性的多源关联分片、不规则分组、自由格间运算、行列对称等技术,使得复杂报表...

泡泡糖儿
35分钟前
5
0
【1015】LNMP架构二

【1015】LNMP架构二 三、PHP安装 PHP安装和LAMP安装PHP方法有差别,需要开启php-fpm服务 1、下载PHP7至/usr/local/src/ 切换目录:cd /usr/local/src 2、解压缩 tar -jxvf php-7.3.0.tar.gz...

飞翔的竹蜻蜓
今天
5
0
浅谈Visitor访问者模式

一、前言 什么叫访问,如果大家学过数据结构,对于这点就很清晰了,遍历就是访问的一般形式,单独读取一个元素进行相应的处理也叫作访问,读取到想要查看的内容+对其进行处理就叫作访问,那么...

青衣霓裳
今天
8
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部