微软放弃Sandcastle有些年头了,微软最近开源了全新的文档生成工具DocFX,目前支持C#和VB,类似JSDoc或Sphinx,可以从源代码中提取注释生成文档之外,而且还有语法支持你加入其他的文件链接到API添加额外的说明,DocFX会扫描你的源代码和附加的文件为你生成一个完整的HTML模版网站,你可以自己通过模版定制,目前已经内嵌了几个模版,包括静态的HTML页面和AngularJS页面.你还可以自己定制模版,具体参考 how to create custom template. 源代码…

在docfx中,最重要的就是生成文档,把markdown文件(gfm语法)转换成html. 为了这一步,我们找了N个.net开源项目,发现要么是common markdown的,要么不容易扩展,没有一个是基于gfm的并且很容易扩展的语法的markdown开源项目.无奈之下,再找.net下执行js的engine,结果发现要么用jint这个解释engine慢慢跑,要么就不能跨平台,或者就各种问题.哎,真是让人抓狂啊... 走投无路之下,还是自己写一个吧,把marked.js的逻辑先翻译一遍,参考了各…

在docfx中把元数据以yaml的形式保存,在metadata阶段会序列化数据到yaml文件中,在build阶段又需要从yaml文件反序列化出来.在使用过程中,意外发现yamldotnet在处理大量强类型数据时性能奇差,将yaml反序列化为弱类型后,再序列化为json,再从json反序列化为强类型,这样看起来超级折腾的3步走竟然比yaml直接反序列化为强类型的性能足足提高了3倍...无奈之下,我们开始尝试自己写个序列化器,于是就有了Microsoft.DocAsCode.YamlSerializ…

废话不多说了,直接上地址: 源代码: https://github.com/dotnet/docfx 文档: http://dotnet.github.io/docfx/ clone git clone https://github.com/dotnet/docfx.git build准备: install IDE vs2015 / 或者装一堆编译要用的东西,不过我没兴趣研究这个... install nodejs dnvm install 1.0.0-rc1-final build IDE下b…

奋战了几个月,docfx终于有些像样了. 预览文档: http://aspnet.github.io/docfx/ 源代码正在准备开源中 Nuget包很快会发布 FAQ: Q: docfx是什么? A: docfx是一个api文档编译软件,它能根据c#/vb源代码生成对应的文档元数据并生成文档(目前提供html),并支持普通md文件. Q: docfx的输入和输出是什么? A: docfx metadata需要源代码来生成文档元数据,docfx build使用文档元数据+普通md文件生成文档(h…

微软开源全新的文档生成工具DocFX 微软放弃Sandcastle有些年头了,微软最近开源了全新的文档生成工具DocFX,目前支持C#和VB,类似JSDoc或Sphinx,可以从源代码中提取注释生成文档之外,而且还有语法支持你加入其他的文件链接到API添加额外的说明,DocFX会扫描你的源代码和附加的文件为你生成一个完整的HTML模版网站,你可以自己通过模版定制,目前已经内嵌了几个模版,包括静态的HTML页面和AngularJS页面.你还可以自己定制模版,具体参考 how to create c…

使用DocFX命令行生成文档 使用docfx 命令 1.下载 https://github.com/dotnet/docfx/releases 2.使用 创建初始项目 docfx init -q 此命令生成一个名为docfx_project的默认项目. 3.生成网站 docfx docfx_project\docfx.json --serve 现在你可以访问http://localhost:8080查看生成的网站.使用 -p 端口 可以指定端口. API文档 将编写的项目复制到docfx_pro…

什么是docFX? DocFX 是一个基于.NET的API文档生成器,当前支持 C# 和 VB.它可以通过你的代码中的三斜杠注释生成 API 参考文档.同样也支持你使用 Markdown 文件创建一些其他的主题文档(例如:教程以及使用手册).以及自定义生成的参考文档.DocFX 会使用你的代码以及 Markdown 文件生成一个静态的 HTML 网站.你可以将它轻松的部署到任何web 服务器(例如: github.io).同样的 DocFX 也提供扩展性,允许你通过模版自定义网站的布局和样式.…

使用DocFX生成PDF文档,将在线文档转换为PDF离线文档. 关于DocFX的简单介绍使用DocFX生成文档 使用docfx 命令 1.下载 https://github.com/dotnet/docfx/releases 2.使用 创建初始项目 docfx init -q 此命令生成一个名为docfx_project的默认项目. 3.生成网站 docfx docfx_project\docfx.json --serve 现在你可以访问http://localhost:8080查看生成的网站.…

由于这三项技术涉及到的要点以及内容较多,希望大家有空能自己挖掘一下更多更深的用法. 0x01.介绍 VS,即VS2017以及以上版本,宇宙最好的IDE,集成了宇宙最有前景的平台,前阶段也支持了宇宙最好的语言. Github,知名的代码/项目托管平台,不想赘述了,如果干两三年了这个都不认识,自觉转行吧,我不在文章里说什么,但你得晓得,我肯定偷偷的鄙视你了. Docfx,类似JSDoc或Sphinx,可以从源代码中提取注释生成文档之外,而且还有语法支持你加入其他的文件链接到API添加额外的说明,Do…