自动生成api文档

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

最近做了一些接口，提供其他人调用，要写个api文档，可是我想代码注释已经写了说明，能不能直接把代码注释生成api？于是找到以下方法

环境：vs2010

先下载安装Sandcastle 和Sandcastle Help File Builder

下载地址

http://sandcastle.codeplex.com/

http://shfb.codeplex.com/

其中Sandcastle Help File Builder安装较复杂，安装红框内的即可

安装完成后，然后让要使用的项目输出xml文档文件

重新生成，能看到输出目录多了这个xml

打开Sandcastle Help File Builder GUI

在右边的project explorer，加载文档资源

PS：这里推荐加载上述输出的xml或dll（或exe），虽然加载工程文件（扩展名*.csproj）也行，但在生成文档是使用后者的速度慢很多，不知为何

然后说说 工程属性 的关键几个

这里可以选择不同格式，我选了chm

help file是文档标题，输出文件名，文档语言，表现风格等

visibility比较关键，控制属性哪些项（私有成员，公有成员，方法，属性，构造函数，基类成员，.net基类成员等），还能控制输出我们写的

哪个类，点击【edit API Filter】进入详细控制

missing tags是是否高亮显示没写的注释，我不想提示，所以大部分没勾

Paths填文件的输出路径

设置完毕后，开始build

输出效果

 

 

分类: ASP.NET, C#, WinForm

标签: ASP.NET, C#, winform