在日常开发中你是否有遇到如下情况
- 进入一个老项目对应的API不知道去哪里找
- 经常重复造轮子
- 功能相同但命名不同的API散落在程序库的各个角落
- 命名相近但功能不同的API充斥整个工程
- 陈旧准备废弃的API被错误的重新启用
如果你也遇到如上问题,那么静态文档生成器Docfx将会给你带来极大的帮助,Docfx可以自动生成对应的API文档,也可将对应生成的html文件上传到网站以供整个团队使用,犹如查询MSDN一样,对于改善工作流可以说是一大利器。
目前Docfx支持的语言是:C#、VB、JavaScript
DocFx官方地址https://dotnet.github.io/docfx/index.html
1.下载文件并解压
下载地址:https://github.com/dotnet/docfx/releases