首页 > 其他分享 >Sandcastle生成文档

Sandcastle生成文档

时间:2023-11-06 10:37:45浏览次数:34  
标签:Sandcastle 配置 程序 dll 文档 生成

下载: https://github.com/EWSoftware/SHFB/releases

使用Sandcastle生成Api文档需要使用对应程序集的注释xml + 程序集dll作为数据源,通过对xml + dll数据解析生成文档;所以主体步骤如下:

  • 程序集资源生成
  • 创建配置.shfbproj项目
  • 编译构建文档

程序集资源生成

生成程序集Api Xml

配置需要生成的程序集Api Xml,默认生成到\bin\Debug\xxx下

image-20230602092253720

输出文件

image-20230602092330398

创建配置.shfbproj项目

此处为使用 Sandcastle Help File Builder GUI进行项目的创建、配置;

当然,你也可以使用vs创建,前提是需要安装vs插件包:四种Sandcastle方法生成c#.net帮助类帮助文档

新建.shfbproj项目

image-20230602092413995

配置项目

配置build

image-20230602092438559

配置help file

image-20230602092455675

添加xml及dll 等资源文件

image-20230602092513328

编译构建文档

使用shfb gui工具

image-20230602092543520

自定义配置生成方法

默认情况下dll中所有方法和属性都会生成对应文档,也可以根据自己需要只把DLL中需要的类或方法生成文档,可通过如下图配置:

image-20230602103610929

image-20230602103624339

标签:Sandcastle,配置,程序,dll,文档,生成
From: https://blog.51cto.com/u_12828212/8201922

相关文章

  • 幼儿园区角中阅读指导的现状及对策研究(论文文档)
    随着知识经济时代的来临以及终身教育理念的倡导,幼儿阅读教育的重要性口益凸显。只有具有良好阅读意识、能力、习惯和情感态度的人,才能够实现终身学习和终身发展,发掘自己的最大潜能,达到自己的最佳发展水平。幼儿园是幼儿所接触到的第一所指导其阅读学习的专业场所,幼儿教师是幼儿阅读......
  • 基于PLC的校园作息时间控制系统——文档
    本设计采用的是PLC控制方式。配置如下:本次PLC控制器采用了三菱的Fx2N一48MRPLC。它拥有24个输入点和24个输出点,可轻易控制继电器等输出设备,实现作息时间的控制。为了让PLC控制器更加精准地控制时间点,设计了5个数码管,其中2个用于显示小时,2个用于显示分钟,一个用于显示星期几。通过......
  • 软件开发项目文档系列之四如何成功撰写一份引人注目的投标文件
    如何成功撰写一份引人注目的投标文件前言撰写投标文件是为了赢得商机,这需要突出公司的优势,同时满足招标方的需求并引起评审委员会的兴趣。成功的投标文件不仅仅是一份文档,更是一项战略性任务。在这篇博客中,我们将深入探讨如何有效地撰写一份引人注目的投标文件,包括分析招标文件......
  • 软件开发项目文档系列之五如何撰写需求规格说明书
    前言撰写需求规格说明书是软件开发项目中的重要步骤,它确保了项目的需求得到明确定义和准确传达,为项目的顺利进行提供了基础。本篇技术博客将深入探讨如何撰写一份全面的需求规格说明书,主要聚焦在前言、任务描述、需求分析和运行环境这四个主要部分。1引言1.1编写目的编写目......
  • 使用Github Copilot生成单元测试并执行
    上一篇文章我们介绍了使用GithubCopilot完成代码编写本文我们继续使用GithubCopilot在已有代码的基础上生成代码测试并执行。一、先说一下代码的背景需要上需要提供一个度量衡的工具类,实现各种转换,例如将长度值转换为英寸将长度值转换为英里将长度值转换为厘米将长度......
  • 生成器和迭代器
    一,生成器和迭代器的区别 生成器和迭代器在Python中都用于处理迭代操作,但它们之间存在一些关键区别。实现方式:迭代器是一个单一的、不可更改的对象,用于遍历(即迭代)一个容器对象(如列表、元组、字典等)。要创建一个迭代器,需要定义一个类并实现两个方法:__iter__() 和 __next__......
  • 在JavaScript中生成随机字符串/字符
    内容来自DOChttps://q.houxu6.top/?s=在JavaScript中生成随机字符串/字符我想要一个由随机从集合[a-zA-Z0-9]中选取的字符组成的5个字符的字符串。在JavaScript中实现这个功能的最佳方法是什么?我认为这个代码可以满足你的需求:functionmakeid(length){letresult=......
  • Go 生成protobuf示例
    先安装好工具goinstallgoogle.golang.org/protobuf/cmd/[email protected]/grpc/cmd/protoc-gen-go-grpc@latest下载安装protocwgethttps://github.com/protocolbuffers/protobuf/releases/download/v25.0/protoc-25.0-linux-x86_64.zip......
  • 基于移动端的个人博客系统的设计与实现-计算机毕业设计源码+LW文档
    摘要博客系统是能够让网民记录分享和学习的一个网站,在博客中我们可以发表文章对感兴趣的事情进行讨论。而基于移动端的个人博客系统的设计是就为了迎合广大用户需求创建的一个界面简洁、有定向内容、业务逻辑简单易操作的博客系统。本文以博客系统的设计与实现为例,提出了利用And......
  • 基于微信小程序的短文写作竞赛管理系统-计算机毕业设计源码+LW文档
    摘 要随着世界经济信息化、全球网络化的到来推动信息线上管理的飞速发展,为短文写作竞赛行业的改革起到关键作用。若想达到安全,快捷的目的,就需要拥有信息化的组织和管理模式,建立一套合理、畅通、高效的短文写作竞赛管理系统小程序。当前的短文写作竞赛管理存在工作效率低下,人员和......