首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

docfx 做一个和微软一样的文档平台 下载安装创建文档文件生成文档查看文档添加文档添加代码文档做自己的修改忽略不使用的api继续微软上开发

开发,有一句话叫 最不喜欢的是写文档,最不喜欢的是看别人家代码没有文档。那么世界上文档写最 la 好 ji 的就是微软了,那么微软的api文档是如何做的?难道请了很多人去写文档?...输入这个命令会生成docfx_project,这里就是新建的文件,可以看到 docfx.json ? 这个文件就是设置文件,可以打开看一下 生成文档 现在就可以进行生成文档了,因为默认就有一些文档。...首先关闭 cmd 再打开,生成文档 docfx.exe ./docfx.json ?...可以看到添加文档需要自己写目录,这个不是很好,所以我就写了一个工具来生成。 添加代码文档 api文档是主要的,生成api文档需要安装vs2015以上。.../index.html 继续微软上开发 可以看到现在的 docfx 还不够好,于是我继续微软做的上面开发。

1.5K10

微软开源全新的文档生成工具DocFX

API添加额外的说明,DocFX会扫描你的源代码和附加的文件为你生成一个完整的HTML模版网站,你可以自己通过模版定制,目前已经内嵌了几个模版,包括静态的HTML页面和AngularJS页面。...docfx,最重要的就是生成文档,把markdown文件(gfm语法)转换成html,微软还开源一个基于gfm的并且很容易扩展的语法的markdown组件 MarkdownLite,代码包含在docfx...FAQ: Q: docfx是什么? A: docfx是一个api文档编译软件,它能根据c#/vb源代码生成对应的文档元数据并生成文档(目前提供html),并支持普通md文件。...A: docfx metadata需要源代码来生成文档元数据,docfx build使用文档元数据+普通md文件生成文档html) Q: docfx支持定制模板么?...A: 是的,可以参考文档 Q: docfx跨平台么? A: docfx支持dnx下运行。

1.3K80
您找到你想要的搜索结果了吗?
是的
没有找到

docfx 简单使用方法、自动生成目录的工具

[摘要] 这是我编写的一个 Docfx 文档自动生成工具,只要写好 Markdown 文档,使用此工具可为目录、文件快速生成配置,然后直接使用 docfx 运行即可。...两个命令 docfx init -q docfx docfx_project\docfx.json --serve // 以实际路径为准 二, 创建 Docfx 项目 使用此命令目录下初始一个...生成文档 docfx docfx_project\docfx.json --serve 预览 对于 项目,可以快速生成对象文档、代码文档。...这里有关于 REST API 生成文档的详细方法 https://dotnet.github.io/docfx/tutorial/intro_rest_api_documentation.html 三,...当然也可以尝试 items 官方详细文档地址 https://dotnet.github.io/docfx/tutorial/intro_toc.html 利用空闲时间写了自动生成 docfx 目录的功能

80520

入门干货之用DVG打造你的项目主页-Docfx、Vs、Github

Docfx,类似JSDoc或Sphinx,可以从源代码中提取注释生成文档之外,而且还有语法支持你加入其他的文件链接到API添加额外的说明,DocFX会扫描你的源代码和附加的文件为你生成一个完整的HTML...哎呀,说白了,就是根据你的.cs 文件生成一些API,注释,首页之类的,就是说,你用吹灰之力就能免去文档的烦恼,就这码事。 0x02、吐槽 我觉得VS上的github插件巨难用,反正我用它上不来气儿。...docfx生成默认环境的那个地方有点不妥,不能覆盖文件夹。 0x03、搭建环境 1、VS,得有Github扩展。...4、打开PM(程序包管理控制台),该目录下(注意你当前环境的路径位置),敲命令: docfx init -q 这个命令是让你生成一个默认的文档编辑框架。...其他选项可以意会,参考文档见:http://dotnet.github.io/docfx/tutorial/docfx_getting_started.html 8、生成:PM里敲: docfx .

82360

【开源】文档生成工具 DocFX

/OpenLiveWriter/OpenLiveWriter/issues/203 详细:http://dotnet.github.io/docfx/tutorial/docfx_getting_started.html...微软最近开源了全新的文档生成工具DocFX,目前支持C#和VB,类似JSDoc或Sphinx,可以从源代码中提取注释生成文档之外,而且还有语法支 持你加入其他的文件链接到API添加额外的说明,DocFX...会扫描你的源代码和附加的文件为你生成一个完整的HTML模版网站,你可以自己通过模版定制, 目前已经内嵌了几个模版,包括静态的HTML页面和AngularJS页面。...DocFX builds a static HTML website from your source code and Markdown files, which can be easily hosted...Build the website docfx docfx_project\docfx.json --serve Now you can view the generated website on http

1.2K40

使用 MarkDown & DocFX 升级 Rafy 帮助文档

文档的每一个文档都是一个 .aml 文件。aml 文件是一种自定义格式的 xml 文件。示例如下: <?xml version="1.0" encoding="utf-8"?...关于 SandCastle 的具体使用方法,可以见:《文档API生成神器SandCastle使用心得》。 DocFX 最近两年,MS 自家的帮助文档大变样,例如 MSDN:《C# Guide》。...其使用的就是最新的文档编写、生成工具:DocFXDocFX 的网址:http://dotnet.github.io/docfx/。...使用帮助,可以看看这篇:《docfx 做一个和微软一样的文档平台》 简单地说,docFX 支持使用 markdown 来编写文档。并最终生成对应的网站。 Markdown 是一个简单标记语言。...然后再通过 docFX生成整个网站。 生成后最新的文档,见:《Rafy 框架简介》,使用的是 DocFX 的默认的皮肤,如下图: ? 这次升级后,以后再编写文档就比较简单了。

1.3K20

XXE注入漏洞

它的设计宗旨是传输数据,不是显示数据。 这里要说的就是DTD。 什么是DTD DTD(文档类型定义,Document Type Definition)的作用是定义 XML 文档的合法构建模块。...它使用一系列的合法元素来定义文档结构。可以嵌入XML文档(内部声明),也可以独立的放在一个文件(外部引用)。如同html里的js一样,可以放在html页面里,也可以是单独的一个文件。...xxe里,AB同一主机上;ssrf,AB不在同一个主机上。 xxe用的是DTD,利用实体注入的方式,将AB联系起来; ssrf,利用Http、File、FTP等协议,将AB联系在一起。...test.php ? 只要执行zz.php文件,就会生成一个load.txt文件 ? 执行原理 zz.php 5.test.php同路径下,新建一个load.txt文件(如果当前目录下没有load.php文件),并将load的值追加保存进去。 可利用的协议 这里协议的作用不是跟ssrf一样。

2.7K32

Go 视图模板篇(一):模板引擎的定义、解析与执行

1、模板和模板引擎 Web 编程,模板引擎用于聚合数据和模板并生成最终的 HTML 文档,处理器调用模板引擎来完成这一工作并将 HTML 文档作为响应实体发送给客户端: ?...2、Go 模板引擎 Go 模板引擎都是处理器触发,指定要解析的模板文件,并传入待渲染的数据,最后返回由模板引擎最终生成HTML 作为 HTTP 响应发送给客户端: ?...Go 模板都是文本文档 Web 应用,通常是 HTML 文档,其中包含了嵌入的命令。这些文档会被 Go 模板引擎解析和执行,生成另外的文本片段(替换完命令和数据)。...> 模板文件的内容必须是可读的文本格式,但是扩展名可以随意,在这里由于最终生成的是 HTML 文档,所以我们使用了 .html 扩展名(tmpl.html)。...此外,我们还可以通过 ParseGlob 方法解析模板,该方法传入的参数是模式匹配串,不是文件名称: t, _ := template.ParseFiles("tmpl.html") t, _ :=

1.6K11

lnmp环境快速搭建及原理解析

刚开始学习php的时候是wamp环境下开发的,后来才接触到 lnmp 环境当时安装lnmp是按照一大长篇文档一步步的编译安装,当时是真不知道是在做什么啊!...lnmp关键性的就两点: 1.nginx接收客户端发来的请求后找到对应的执行脚本文件再用php-fpm来解释执行脚本文件并将结果返回给客户端 2.php通过php扩展pdo、mysql、或者mysqli...下面我们先实现下 nginx 和 php的通讯,这里我们先要明确下nginx的配置文件什么地方,这里可以使用以下命令找一下 sudo find / -name nginx.conf 找到文件...页面不是PHP页面。..." ,打开该文件我们会看到这条语句 listen = /run/php/php7.0-fpm.sock 这里监听的 listen 值 与 nginx.conf fastcgi_pass 的值是相对应的

89320

Web安全学习笔记之Kali部署DVWA和OWASPBWA

赋予dvwa文件夹相应的755权限,接着终端输入: chmod -R 755 /var/www/html/dvwa ?...赋予dvwa文件夹内文件相应的755权限,接着终端输入: cd /var/www/html/dvwa/ chmod 755 hackable/uploads/ chmod 755 external/...修改php配置文件 找到 '' /etc/php/7.2/apache2/ '' 文件夹,用文档编辑器打开 '' php.ini '' 文件 更改如下两项: ''allow_url_include=Off...进入到  /var/www/html/dvwa/config 文件夹,把配置模版文件config.inc.php.dist 复制一份 , 并命名为config.inc.php ?...右键,用文档编辑器打开该文件,配置 ‘ReCAPTCHA settings’,将谷】歌生成的keys分别填入如下部分(生成ReCAPTCHA请自行学习); ? ReCAPTCHA需要找谷。

3.5K50

B2R2:一套针对二进制代码分析的实用算法、函数以及工具集

B2R2 B2R2是一套针对二进制代码分析的实用算法、函数以及工具集,B2R2采用纯F#(.NET)开发,B2R2原名为B2-R2,其命名引用的是R2-D2,因为.NET不允许标识符或命名空间中使用字符...下面给出的是B2R2所需的依赖库列表: 1、System.Reflection.Metadata 2、Microsoft.FSharpLu.Json 3、FParsec API文档 我们当前使用了docfx...来生成B2R2的API文档:【https://b2r2.org/APIDoc/】。...1、首先,我们需要生成一个名为“DIRNAME”的空目录: mkdir DIRNAME 2、然后,使用dotnet命令命令行工具中常见一个空的终端项目: $ dotnet new console -lang...F# 3、将B2R2.FrontEnd包添加进项目中: $ dotnet add package B2R2.FrontEnd 4、使用我们熟悉的编辑器修改Program.fs文件: open B2R2open

67740

何为伪静态,如何快速实现。(别人原创,我改编转发)

什么是静态网页 所谓静态网站, 就是真实存在于Web服务器上的html文档 用户访问时, 只需要在浏览器地址栏输入这个文档的完整URL地址就可以 静态网页,非常有利于SEO优化, 对于网站的收录和排名非常有利...什么是动态网页 所谓动态网页, 是指网页的数据是动态生成的, 通常是来自数据库 这些数据,只有当存在用户请求时, 数据才会与页面结构结合,动态生成一个完整页面返回给用户 这类网站最典型的特征,就是URL....htaccess文档 下面是一个简单的小案例, 我们浏览器地址栏输入: index.html, 实际上访问的是动态页面index.php # 启动rewrite引擎 RewriteEngine on...# 将index.html 映射到 index.php RewriteRule ^index.html$ /index.php ThinkPHP5.1的.htaccess <IfModule mod_rewrite.c..., 如果不是文件, 才将URL交给下一条规则处理   RewriteCond %{REQUEST_FILENAME} !

1.3K10

用于检查和改进代码的PHP代码质量工具

但是,既然你是一个尊敬的人,你知道这不是一个好的解决方案。教学不是责备总能带来更好的结果。 有了一个禅宗僧人的平静,你首先修复了戴夫的帮助下驾驶你的老板疯狂的错误。...我建议你从项目的主文件调用这些工具。每个示例都假设您的代码库位于该文件 src。 Vim / Neovim 您可以Vim轻松配置所需的每个工具,并让它们解析打开的文件。...它将显示阴沟警告和错误。非常便利! 您甚至可以创建自己的制造商来使用您想要的每个PHP代码质量工具。作为参考,您可以参考我的 neomake配置文件 。...期待你的同事开发人员戴夫试图让你更加努力,让他在你的耻辱阴影闪耀。 要显示CRAP指标,您需要生成代码覆盖率报告: $ phpunit phpunit --coverage-html ....Time: 29 ms, Memory: 4.00MB 您可以包含多个文件不是整个目录,排除某些文件(或路径),甚至可以将结果输出到XML文件

2.7K20

tcpdf中文字体_pdf和tif有什么区别

最近在做将网页内容输出成pdf文档方面的一个项目,找了好多类,php_pdflib,fpdf,HTML_topdf等等,不过最终还是发现这个好用,究其汉字处理方面发现了写一篇文章,就抄过来了,以供大家参考...TCPDF 是一个用于快速生成PDF文件PHP5函数包。TCPDF基于FPDF进行扩展和改进。支持UTF-8,Unicode,HTML和XHTML。...基于 PHP开发的Web应用,使用它来输出PDF文件是绝佳的选择。但毕竟这款开源软件是外国人开发的,对中文的支持总不是那么尽如人意,因此我们需要对它 作进一步的增强。 首先要下载TCPDF。...命令行输入 “C:\Program Files\WAMP\PHP5\php.exe” -q makefont.php DroidSansFallback.ttf DroidSansFallback.ufm.../tcpdf/examples/example_038.php 就可以看到重新生成的PDF文档

4K10

Google 开源技术protobuf

protobuf这样的库正好是效率、数据大小、易用性之间取得了很好的平衡。 官方文档 http://code.google.com/p/protobuf/ 2....你可以API参考( http://code.google.com/apis/protocolbuffers/docs/reference/overview.html )中找到完整的参考,关于ProtocolBuffer...也可以消息内定义一个新的消息。 关于enum 枚举的定义和C++相同,但是有一些限制。 枚举值必须大于等于0的整数。 使用分号(;)分隔枚举变量不是C++语言中的逗号(,) eg..../parser/pb_parser.php'); 结果在mytest目录下生成一个文件:pb_proto_test_new.php 到此,假如这个数据协议是客户端。...假设test.pb文件是经过网络传输到服务器上的(这里都是本地)。 然后服务器端也可以根据这个协议,生成对应类。

2.2K20

PHP经典面试题目汇总(上篇)

3.1表单get和post提交方式的区别 get是把参数数据队列加到提交表单的action属性所指的url,值和表单内各个字段一一对应,从url可以看到;post是通过HTTPPOST机制,将表单内各个字段与其内容防止...,PHP是将程序嵌入到HTML文档中去执行,效率比完全生成HTML编辑的CGI高很多 HTML: Hypertext Markup Language 创始人: 拉姆斯勒·勒多夫Rasmus Lerdorf...可以比CGI或者Prel更快速去执行动态网页,与其他变成语言相比,PHP是讲程序嵌入到HTML文档中去执行,执行效率比完全生成HTML编辑的CGI要高很多,所有的CGI都能实现 支持几乎所有流行的数据库以及操作系统...,var_dump和print_r是函数 * echo 输出一个或多个字符串,中间以逗号隔开,没有返回值是语言结构不是真正的函数,因此不能作为表达式的一部分使用 * print也是php的一个关键字,...是致命的,include不是 require_once表示了只包含一次,避免了重复包含 15、谈谈mvc的认识 由模型、视图、控制器完成的应用程序,由模型发出要实现的功能到控制器,控制器接收组织功能传递给视图

3.4K70
领券