C# Sandcastle 生成Document（Chm格式）三种方法

C# Sandcastle 生成Document（Chm格式）3种方法

C# Sandcastle 生成Document（Chm格式）3种方法

今天研究了一下Sandcastle，一个生成像javadoc的东西。感觉以后也会用到所以给自己留个印象。在这里写下一篇文章

大家都会遇到这样的问题：

用Sandcastle生成的doc报出警告说XXXnamespace 没有<summary>

这下我就想问了，怎么给C#的代码namespace加注释呢？

哈哈

研究了一下，发现有3中

第一种：

namespace Some.Test

{

    /// <summary>

    /// The <see cref="Some.Test"/> namespace contains classes for ....

    /// </summary>

    [System.Runtime.CompilerServices.CompilerGenerated]

    class NamespaceDoc

    {

    }

}

如上代码就可以

第二种:

<?xml version="1.0"?>

<doc>

   <members>

             <member name="R:Project">

              <summary>About the project.</summary>

             </member>

             <member name="N:xxx">

                           <summary>

                                       xxx  

                            </summary>

             </member>

             <member name="N:xxx">

              <summary>

                            The interface xxx

              </summary>

             </member>

             <member name="N:xxx">

              <summary>

                            The interface xxx

              </summary>

             </member>

   </members>

</doc>

以上代码也可以

第三种：

用Sandcastle 自带的功能给project和namespace加注释就OK了

 

好了 以上就是了

有什么问题请和我联系