提取注释生成API文档

 

一、前言                              

在多人协作的项目中,除了良好的代码规范外,完整的API文档也相当重要。通过文档我们快速了解系统各模块的实际接口,及其使用场景、使用示例,一定程度上降低沟通成本,和减少后期维护中知识遗失等风险。

对于.Net,我们可以直接将类、方法等的注释直接转为API文档,极大地减少文档维护的工作量,同时也能反向提高大家的注释质量。

下面我们使用.Net唯一的注释生成API文档工具——Sandcastle和Sandcastle Help File Builder来实现API文档自动化吧!

二、工具                              

Sandcastle: http://sandcastle.codeplex.com/

Sandcastle Help File Builder:http://shfb.codeplex.com/

三、从注释到API文档                        

1. 生成XML文档文件

步骤:1. 在VS中,右击程序集->选择“属性”->选择“生成”页->勾选“XML文档文件”

2. 编译程序集后,在生成目录下可以找到“程序集名称.XML”文件。

2. 使用SandcastleBuilderGUI.exe生成API文档

安装工具Sandcastle和Sandcastle Help File Builder后,点击SandcastleBuilderGUI.exe即可进入文档生成项目的界面。

  步骤:1. 配置文档基本信息:点击“Help File”页

  按照上图,依次配置文档标题,文档名称,文档语言,文档风格。

  2. 将程序集DLL和XML文件加载到文档生成项目中。

  右击“Documentation Sources”,选择“Add Documentation Sources”,然后将程序集DLL和XML添加进来即可。

3. 生成API文档

   点击菜单栏的“Documentation”->“Build Project”即可,此时只需到Sandcastle Help File Builder.exe所在的目录即可找到API文档了。

四、总结                                

上述仅介绍了Sandcastle Help File Builder的部分功能,日后将逐渐补充。

尊重原创,转载请注明来自:http://www.cnblogs.com/fsjohnhuang/p/3968313.html  ^_^肥仔John

五、参考                                

http://guojun2sq.blog.163.com/blog/static/643308612010116394430/

http://www.boyd.cn/info_Show.asp?ArticleID=4945

http://blog.csdn.net/chtnj/article/details/8278342

http://blog.csdn.net/chtnj/article/details/8278360

.net 提取注释生成API文档 帮助文档的更多相关文章

  1. .Net魔法堂:提取注释生成API文档

    一.前言 在多人协作的项目中,除了良好的代码规范外,完整的API文档也相当重要.通过文档我们快速了解系统各模块的实际接口,及其使用场景.使用示例,一定程度上降低沟通成本,和减少后期维护中知识遗失等风险 ...

  2. 使用sphinx快速为你python注释生成API文档

    sphinx简介sphinx是一种基于Python的文档工具,它可以令人轻松的撰写出清晰且优美的文档,由Georg Brandl在BSD许可证下开发.新版的Python3文档就是由sphinx生成的, ...

  3. 注释生成Api文档

    1.开发背景 最近一直在写dubbo接口,以前总是用word文档写接口描述然后发给别人.现在太多了,而且跟别人对接联调的人家急着用,根本没时间去写word文档.那就想想怎么用doc文档注释自动生成接口 ...

  4. C# 代码注释生成代码提示和帮助文档

    C#文档注释格式: /// <summary> /// function description /// </summary> /// <param name=" ...

  5. vs2010代码注释自动生成api文档

    最近做了一些接口,提供其他人调用,要写个api文档,可是我想代码注释已经写了说明,能不能直接把代码注释生成api?于是找到以下方法 环境:vs2010 先下载安装Sandcastle 和Sandcas ...

  6. 试试使用 eolinker 扫描 GitLab 代码注释自动生成 API 文档?

    前言: 一般写完代码之后,还要将各类参数注解写入API文档,方便后续进行对接和测试,这个过程通常都很麻烦,如果有工具可以读取代码注释直接生成API文档的话,那会十分方便. 此前一直都是在使用eolin ...

  7. 自动生成api文档

    vs2010代码注释自动生成api文档 最近做了一些接口,提供其他人调用,要写个api文档,可是我想代码注释已经写了说明,能不能直接把代码注释生成api?于是找到以下方法 环境:vs2010 先下载安 ...

  8. 三分钟学会 ASP.NET Core WebApi使用Swagger生成api说明文档

    什么是Swagger?为啥要用Swagger? Swagger可以从不同的代码中,根据注释生成API信息,Swagger拥有强大的社区,并且对于各种语言都支持良好,有很多的工具可以通过swagger生 ...

  9. Java:API文档;文档注释中的javadoc标记;官方API;自己动手给项目建一个API文档

    1.什么是API文档 在Java语言中有3种注释 //单行注释 /* 多行注释 */ /** * 文档注释 */ API(应用程序接口)文档就是用javadoc命令提取文档注释生成的,html格式,用 ...

随机推荐

  1. 'workspace' in VS Code

    What is a 'workspace' in VS Code? You can save settings at the workspace level and you can open mult ...

  2. Bzoj 4371: [IOI2015]sorting排序 二分

    题目 似乎很久没写题解了... 这题是校里胡策的时候的题,比赛因为评测机有点慢+自己代码常数大没快读...被卡t了,但是bzoj上还是A了的...,因为bzoj时限比较宽可以不卡常. 题解: 首先可以 ...

  3. java 23种设计模式,一般情况下,常用的有哪些? 转载

    原址:http://wangle.iteye.com/blog/196972 工厂模式, 工厂方法模式,单例模式, 外观(Facade)模式, 观察者(Observer)模式,桥接(Bridge)模式 ...

  4. 从零开始,使用Docker Swarm部署集群教程

    本文首先从Dockerfile创建了一个简单web镜像 然后将web镜像推送到了远程仓库,以备后面集群中不同机器自动下载 之后使用docker-compose.yml配置了一个应用 而后新建了2台虚拟 ...

  5. shell 输入不显示在监视器上

    #!/bin/bash read -s -p "Enter your password:" pass echo "your password is $pass" ...

  6. Adapter Class/Object(适配器)

    意图: 将一个类的接口转换成客户希望的另外一个接口.Adapter 模式使得原本由于接口不兼容而不能一起工作的那些类可以一起工作. 适用性: 你想使用一个已经存在的类,而它的接口不符合你的需求. 你想 ...

  7. Flex 布局的各属性取值解释

    Flex布局是一种弹性布局.布局样式比较灵活,大多数情况下可以替代float,而且不会脱离文档里流. Flex中定义了两个轴线,一个主轴一个副轴,这个概念你可以想想屏幕坐标系(X轴向右,Y轴向下),F ...

  8. Angular单元测试

    https://angular.github.io/protractor/#/http://jasmine.github.io/2.4/introduction.html 测试程序有两种主要方法:端对 ...

  9. git关于 LF 与 CRLF

    问题描述: 今天在idea上配置好了git操作到push,目测都没遇到什么问题. 但是再次点击提交按钮的时候,仍然提示我所有的文件都是需要提交的(我的主题中蓝色显示) 然而本地并无改动,在提交窗口得到 ...

  10. 无法安装64位版本的office因为在您的pc

    无法安装64位版本的office因为在您的pcWindows Registry Editor Version 5.00 [HKEY_CLASSES_ROOT\Installer\Products\00 ...