`

C# Sandcastle 生成Document(Chm格式)3种方法

    博客分类:
  • C#
阅读更多

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 的功能projectnamespace加注OK

 

好了 以上就是了

有什么问题请和我

 

0
3
分享到:
评论

相关推荐

    Sandcastle(.net程序集CHM帮助文件生成器)

    在.NET框架中,Sandcastle工具正是用于生成高质量、详尽的程序集文档,尤其是CHM(Compiled Help Manual)帮助文件,这种格式通常用于离线查看,方便开发者随时查阅。本文将深入探讨Sandcastle的工作原理、使用方法...

    C#生成CHM帮助文件源码

    生成CHM文件的C#库和工具通常包括像HtmlHelpWriter、Sandcastle等,它们提供API来方便地创建hhp、hhc和hhk文件。开发者可以通过调用这些库的函数,结合项目需求,实现自定义的CHM生成逻辑。 总之,C#生成CHM帮助...

    Sandcastle-帮助生成工具

    Sandcastle支持的输出格式多样,如常见的CHM文件,这是一种便于离线查看的Windows帮助文件格式。此外,HTML格式适合在线查看,而XML格式则方便进行进一步的自定义和处理。 **Sandcastle与Visual Studio集成** 除了...

    将C# 类文件中属性和方法自动生成文档,C#类文档结构化生成

    本话题将深入探讨如何自动生成C#类中的属性和方法的文档,以及涉及到的相关工具和技术。 一、XML注释与文档生成 C#支持XML注释,它允许程序员在代码中添加结构化的注释,这些注释可以被工具转换为格式化的文档。...

    C# 代码生成器源码 最新版

    C# 代码生成器是一种工具,它能够自动化创建C#编程语言的源代码,从而减少开发者手动编写重复性代码的工作量。这样的工具通常基于模板或规则引擎,通过元数据、数据库模式、WSDL文件等输入,自动生成符合特定设计...

    Sandcastle 文档生成工具

    Sandcastle 微软官方的文档生成工具

    Sandcastle代码帮助文档生成器

    在C#或VB.NET等.NET语言中,开发者可以在方法、类、接口等元素上添加XML注释,这些注释将在文档生成过程中被解析和使用。 2. **配置项目**:使用`InstallerConfiguration.xml`文件可以设置Sandcastle的生成选项,如...

    SHFB生成CHM的Demo

    标题中的"SHFB生成CHM的Demo"指的是使用Sandcastle Help File Builder(SHFB)创建一个帮助文件(CHM)的示例项目。Sandcastle Help File Builder是一个开源工具,主要用于生成专业的.NET框架程序文档,包括HTML帮助...

    强大的C#API文档生成工具

    它从dll文件及其xml注释文件能够生成完整的帮助文档,支持多种生成格式(Helpe1x:chm, Helper2x:Hxs, Website,HelperView),结合新发布的Sandcastle Help File Builder可视化工具,整个生成过程十分简单,而且SHFB工具...

    SandcastleHelpFileBuilder2017有一个25页的使用说明文档

    这个是c#类库方法根据注释生成帮助文档的工具,我们经常会遇到把DLL或者API提供给别人调用的情况,通过在方法中添加注释,然后再用Sandcastle 来自动生成文档给调用者,如下 单纯Sandcastle好像是没有界面的, 这个...

    C#根据注释生成文档

    在C#编程语言中,有一种高效的方法是利用源代码中的注释来自动生成文档,这种方法既节省时间又确保了文档与代码的一致性。本文将详细介绍如何利用注释和特定工具来实现这一目标。 首先,我们要知道C#支持两种主要的...

    SandcastleBuilder c#代码帮助文档生成器

    SandcastleBuilder是一款专为C#开发者设计的帮助文档生成工具,它能够自动生成CHM(Compiled Help Manual)格式的API文档,让开发者轻松构建出专业且规范的代码文档。 一、SandcastleBuilder概述 SandcastleBuilder...

    Sandcastle+SandcastleHelpFileBuilder

    Sandcastle支持生成多种输出格式,包括CHM(Windows帮助文件)、HTML以及XML。 Sandcastle的特点在于它的灵活性和准确性。它能准确地反映出代码结构,并且允许开发者通过自定义模板来自定义输出样式。然而,...

    Sandcastle加图形工具加中文模板

    自动根据 VS2005 VS2008 的 XML注释生成CHM帮助文档的软件、模板、帮助 包含以下文件: Sandcastle2.4.10520.zip:命令行界面的Sandcast,界面是英文的。 SandcastleBuilderSetup_1801.zip:第三方开发GUI界面方便...

    sandcastle使用小结

    Sandcastle 是微软的用于编译发布组件信息的一个工具,它可以从 dll 文件及其 xml 注释得到一个完整的帮助文档,格式可以是 Html 或 CHM。 Sandcastle 的使用方式是命令行,为了使用直观方便,需要安装一个 GUI 工具...

    Sandcastle和SandcastleHelpFileBuilder

    Sandcastle和SandcastleHelpFileBuilder是微软开发的两个重要工具,专门用于生成高质量的API文档。在IT行业中,尤其在软件开发领域,清晰、详尽的文档是至关重要的,它们帮助开发者理解代码的功能、用法以及接口之间...

    Sandcastle

    Sandcastle 是一个文档生成工具,可以用它生成 MSDN 风格的文档,既能够生成 chm 文档,也能够生成 MS Help 2.x 帮助文档。在此之前曾流行的 NDoc,其作者已经放弃更新。 参考: ... ... 安装说明:安装...

    SandCastle Help File Builder V1.9.7.0

    SandCastle是由Microsoft开源的一款文档生成工具,它基于XML文档注释,能够自动生成符合MSDN风格的CHM(Windows帮助文件)或HTML格式的帮助文档。SandCastle Help File Builder(SHFB)是其上层的封装,提供了更友好...

    VS c# 生成 文档 注释 源代码

    1. **XML文档注释**:这是C#中用于生成文档的一种机制,通过在代码中使用三联斜杠(///)注释,VS可以在编译时生成一个XML文件,记录下这些注释。 2. **Visual Studio 项目属性**:在VS中,项目属性可以设置各种...

    微软DOC生成工具(带GUI)Sandcastle

    2. **模板驱动的文档生成**:Sandcastle提供了多种输出格式,如HTML帮助文件(CHM)、HTML Web帮助、以及XML格式的文档。它使用模板系统来决定文档的外观和布局,用户可以根据需要自定义模板。 3. **GUI界面**:...

Global site tag (gtag.js) - Google Analytics