在线文档生成工具介绍_第1页
在线文档生成工具介绍_第2页
在线文档生成工具介绍_第3页
在线文档生成工具介绍_第4页
在线文档生成工具介绍_第5页
已阅读5页，还剩9页未读， 继续免费阅读

下载本文档

版权说明：本文档由用户提供并上传，收益归属内容提供方，若内容存在侵权，请进行举报或认领

文档简介

1、1、DocFx插件这是一个开源的插件，支持通过Nuget方式安装。安装完成后会在项目的根目录下生成toc.yml、docfx.json两个文件和_site文件夹，这个_site文件里面就是生成的api文档。这个工具生成原理是通过反射抽取出字段和方法自动生成类信息帮助文档。 源代码： 帮助文档：http:/dotnet.github.io/docfx/tutorial/docfx_getting_started.html 安装方法：Install-Packagedocfx.msbuild2、Apidocjs在线文档工具 这是一个跨平台的api文档生成工具，通过nodejs管理（grunt-api

2、doc），生成方式比较灵活，不依赖原项目，可以单独建立api文档项目，也可以在原有代码里增加apidoc格式的注释来生成文档。 源代码： 帮助文档： 安装方法： (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文件文件”输出。 帮助文档： 安装方法：Install-PackageMicrosoft.AspNet.WebApi.HelpPage Install-PackageWebApiTestOnHelpPage a. 安装完成后需要配置对生成的*.xml的注册 b. 在项目属性里选择生成注释文档*.xml的生成

人人文库> 全部分类> 教育资料 > 课件下载

温馨提示

  • 1. 本站所有资源如无特殊说明，都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等，如果需要附件，请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸，网页内容里面会有图纸预览，若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间，仅对用户上传内容的表现方式做保护处理，对用户上传分享的文档内容本身不做任何修改或编辑，并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容，请与我们联系，我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

最新文档

评论

0/150

提交评论