将C#文档注释生成.chm帮助文档

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

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

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

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161

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

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

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

选择刚刚生成的DLL文件。

第四步，修改设置

在项目的属性窗口，你可以根据需要修改一些设置。只生成C#帮助，继承的属性不显示

第五步，生成文档

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

这是最终生成的文档：

 

程序员的基础教程：菜鸟程序员