使用SandCastle创建.Net帮助文档

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;

        }

    }

}