使用Sandcastle 基于代码注释生成接口文档

一. 工具下载：

1. Sandcastle：Sandcastle是微软官方的文档生成工具，下载地址：http://www.codeplex.com/Sandcastle

2. SHFBGuidedInstaller：Sandcastle结合新发布的Sandcastle Help File Builder可视化工具，整个生成过程十分简单。下载地址：http://shfb.codeplex.com/

分别安装以上两个工具后，打开 Sandcastle Help File Builder GUI

选择File->New Project

找一个位置保存我们的配置文件，通常放在我们的项目的根目录下，保存成功后，如图：

接下来，我们就添加我们的DLL文件了，添加之前，我们要在我们的代码中添加注释，及配置生成XML文档

在Documentation Sources上右键，Add Documentation Source,找到我们刚生成的XML文件（DLL文件也行它会自动把两个文件同时加入进来）

添加成功后，我们就开始配置中间的部分：

首先看Build，它让我们选择生成什么样的文档，默认勾选第一个，但是CHM文档需要单独安装一个东档，先不管它，我们先生成website的就可以了。

在Help File中，我们要注意以下几项：语言选中文，Presentation style这个没用，我的vs是2017，它连个选项都没有，应该还支持2017，

include root namespace container要勾选，否则只生成一个命名空间的文档。

其它的配置，根据需要写。

在Summaries,里配置要生成文档的命名空间：

其它的配置省略。。。

最后点击build

注释文档就生成了。

转载于:https://www.cnblogs.com/hankuikui/p/7724322.html

使用Sandcastle 基于代码注释生成接口文档相关推荐

XDoc 基于Java注释生成API文档
XDoc 基于Java注释生成API文档  <dependency><groupId>com.github.treeleafj< ...
快速根据注释生成接口文档网页工具——Apidoc的使用教程
环境: 操作系统 CentOS Linux release 7.6.1810 (Core) 64位服务器环境 "腾讯云"服务器 1,安装Node.js的npm工具环境: ...
axis2生成客户端代码_利用ApiPost一键、快速生成接口文档！女猿也过38节！
对于我们这些程序员和程序媛来讲,最头疼的莫过于写文档. 我们可都是正个八经的理工校草和理工女神,研究github.逛逛csdn.写hello world是才我们的拿手菜,写文档是文科生的事情好不啦?( ...
Spring Boot（九）Swagger2自动生成接口文档和Mock模拟数据
一.简介在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 问题一.后端接口查看难:要怎么调用?参数怎么传递?有几个参数?参数都代表什么含义? 问题二 ...
idea swagger生成接口文档_Spring Boot（九）Swagger2自动生成接口文档和Mock模拟数据...
一.简介在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 问题一.后端接口查看难:要怎么调用?参数怎么传递?有几个参数?参数都代表什么含义? 问题二 ...
SpringBoot 整合Smart-doc生成接口文档
之前我在SpringBoot老鸟系列中专门花了大量的篇幅详细介绍如何集成Swagger,以及如何对Swagger进行扩展让其支持接口参数分组功能.详情可见:SpringBoot 如何生成接口文档,老鸟 ...
[Golang梦工厂]一个小项目带你学会GIN框架、JWT鉴权、swagger生成接口文档，看这一篇就够了
前言哈喽,大家好,我是asong,这是我的第八篇原创文章.听说你们还不会jwt.swagger,所以我带来一个入门级别的小项目.实现用户登陆.修改密码的操作.使用GIN(后台回复Golang梦工厂: ...
还在用Swagger生成接口文档？我推荐你试试它.....
点击上方"方志朋",选择"设为星标" 回复"666"获取新整理的面试文章 JApiDocs是一个无需额外注解.开箱即用的SpringBoot ...
springboot 中文文档_比Swagger还好用的自动生成接口文档工具
JApiDocs是一个无需额外注解.开箱即用的SpringBoot接口文档生成工具. 编写和维护API文档这个事情,对于后端程序员来说,是一件恼人但又不得不做的事情,我们都不喜欢写文档,但除非项目前后 ...

使用Sandcastle 基于代码注释生成接口文档

使用Sandcastle 基于代码注释生成接口文档相关推荐

最新文章

热门文章