.Net魔法堂:提取注释生成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

目录
相关文章
|
2月前
|
开发框架 前端开发 JavaScript
ASP.NET MVC 教程
ASP.NET 是一个使用 HTML、CSS、JavaScript 和服务器脚本创建网页和网站的开发框架。
37 7
|
2月前
|
存储 开发框架 前端开发
ASP.NET MVC 迅速集成 SignalR
ASP.NET MVC 迅速集成 SignalR
52 0
|
3月前
|
开发框架 前端开发 .NET
ASP.NET MVC WebApi 接口返回 JOSN 日期格式化 date format
ASP.NET MVC WebApi 接口返回 JOSN 日期格式化 date format
44 0
|
3月前
|
开发框架 前端开发 安全
ASP.NET MVC 如何使用 Form Authentication?
ASP.NET MVC 如何使用 Form Authentication?
|
3月前
|
开发框架 .NET
Asp.Net Core 使用X.PagedList.Mvc.Core分页 & 搜索
Asp.Net Core 使用X.PagedList.Mvc.Core分页 & 搜索
118 0
|
6月前
|
开发框架 前端开发 .NET
ASP.NET CORE 3.1 MVC“指定的网络名不再可用\企图在不存在的网络连接上进行操作”的问题解决过程
ASP.NET CORE 3.1 MVC“指定的网络名不再可用\企图在不存在的网络连接上进行操作”的问题解决过程
184 0
|
6月前
|
开发框架 前端开发 JavaScript
JavaScript云LIS系统源码ASP.NET CORE 3.1 MVC + SQLserver + Redis医院实验室信息系统源码 医院云LIS系统源码
实验室信息系统(Laboratory Information System,缩写LIS)是一类用来处理实验室过程信息的软件,云LIS系统围绕临床,云LIS系统将与云HIS系统建立起高度的业务整合,以体现“以病人为中心”的设计理念,优化就诊流程,方便患者就医。
75 0
|
6月前
|
开发框架 前端开发 .NET
C# .NET面试系列六:ASP.NET MVC
<h2>ASP.NET MVC #### 1. MVC 中的 TempData\ViewBag\ViewData 区别? 在ASP.NET MVC中,TempData、ViewBag 和 ViewData 都是用于在控制器和视图之间传递数据的机制,但它们有一些区别。 <b>TempData:</b> 1、生命周期 ```c# TempData 的生命周期是短暂的,数据只在当前请求和下一次请求之间有效。一旦数据被读取,它就会被标记为已读,下一次请求时就会被清除。 ``` 2、用途 ```c# 主要用于在两个动作之间传递数据,例如在一个动作中设置 TempData,然后在重定向到另
318 5
|
6月前
|
开发框架 前端开发 .NET
进入ASP .net mvc的世界
进入ASP .net mvc的世界
|
6月前
mvc.net分页查询案例——mvc-paper.css
mvc.net分页查询案例——mvc-paper.css