在线文档生成工具介绍解析.docxVIP

1、DocFx插件这是一个开源的插件，支持通过Nuget方式安装。安装完成后会在项目的根目录下生成toc.yml、docfx.json两个文件和_site文件夹，这个_site文件里面就是生成的api文档。这个工具生成原理是通过反射抽取出字段和方法自动生成类信息帮助文档。? 源代码：/dotnet/docfx?? 帮助文档：?http://dotnet.github.io/docfx/tutorial/docfx_getting_started.html?? 安装方法：Install-Package?docfx.msbuild2、Apidocjs在线文档工具? ?这是一个跨平台的api文档生成工具，通过nodejs管理（grunt-apidoc），生成方式比较灵活，不依赖原项目，可以单独建立api文档项目，也可以在原有代码里增加apidoc格式的注释来生成文档。? ?源代码：/apidoc/apidoc?? ?帮助文档：/index.html#getting-started?? ? ? ? ? ? ? ?/p/bb5a4f5e588a? ?安装方法：? ? (1). 先安装nodejs环境，基于grunt管理apidoc(先安装grunt-cli: npm install –g grunt-cli)；? ? (2). 在项目中添加环境包配置文件package.json以及项目配置文件Gruntfile.js；? ? (3). 在nodejs环境下执行命令生成api文档（grunt）；? ? a. ?创建一个api在线文档项目? ??? ? b. 项目配置说明? ??? ??? ? c. 注释源文档说明，apidoc通过扫描注释源文件生成在线文档? ??? ? c. 生成效果? ??? ??3、Microsoft.AspNet.WebApi.HelpPage插件? ? 这是一个开源插件，支持通过Nuget方式安装。安装完成后会在项目根目录下生成Areas文件夹，它依赖于项目生成的*.xml文档，需要在项目属性里选中“XML文件文件”输出。? ? 帮助文档：?/pmars/p/3673654.html?? ??? ??? ??? ??? ??/web-api/overview/getting-started-with-aspnet-web-api/creating-api-helps?? ?安装方法：Install-Package?Microsoft.AspNet.WebApi.HelpPage? ??? ??? ??? ??? ????Install-Package?WebApiTestOnHelpPage?? ??? ? a. 安装完成后需要配置对生成的*.xml的注册? ?? ? ?b. 在项目属性里选择生成注释文档*.xml的生成位置与注册地址一致? ??? ??? ? c. 对要生成的接口进行注释，就可以生成api文档? ??? ?d. 生成文档效果图? ?? ?? ??