- 综合排序
- 最热优先
- 最新优先
- 来自专栏JusterZhu
docfx
DocFX是一个静态文档生成器，用于帮助开发者创建高质量的API文档、用户手册和其他类型的技术文档。它能够从Markdown文件、代码注释和其他文档源自动生成文档，并支持多种文档格式。 DocFX提供了丰富的主题和插件，允许用户定制文档的外观和功能。它被广泛用于软件项目、开源项目和企业文档等领域，为文档的创建和维护提供了便捷的工具。 它具有以下功能： 自动生成API文档： DocFX可以从代码注释中提取信息，自动生成详细的API文档，包括类、方法、参数等说明。 多语言支持： DocFX支持多种编程语言，包括C#和VB等。 与代码集成： 可以直接从源代码中提取注释，与代码紧密集成，确保文档的准确性。 github仓库地址：https://github.com/dotnet/docfx 教程：https://dotnet.github.io/docfx/ 运行效果
35720编辑于 2023-10-24 - 来自专栏逸鹏说道
【开源】文档生成工具 DocFX
源码：https://github.com/dotnet/docfx 下载：https://github.com/dotnet/docfx/releases 说明：https://github.com 微软最近开源了全新的文档生成工具DocFX，目前支持C＃和VB，类似JSDoc或Sphinx，可以从源代码中提取注释生成文档之外，而且还有语法支 持你加入其他的文件链接到API添加额外的说明，DocFX What is DocFX DocFX is an API documentation generator for .NET, and currently it supports C# and VB. Use DocFX as a command-line tool Step1. DocFX ships as a chocolatey package. Build the website docfx docfx_project\docfx.json --serve Now you can view the generated website on http
1.4K40发布于 2018-04-11 - 来自专栏哲学驱动设计
使用 MarkDown & DocFX 升级 Rafy 帮助文档
最近使用 DocFX 对 Rafy 框架的帮助文档进行了升级。 DocFX 最近两年，MS 自家的帮助文档大变样，例如 MSDN：《C# Guide》。 其使用的就是最新的文档编写、生成工具：DocFX。 DocFX 的网址：http://dotnet.github.io/docfx/。 使用帮助，可以看看这篇：《docfx 做一个和微软一样的文档平台》 简单地说，docFX 支持使用 markdown 来编写文档。并最终生成对应的网站。 Markdown 是一个简单标记语言。 然后再通过 docFX 来生成整个网站。 生成后最新的文档，见：《Rafy 框架简介》，使用的是 DocFX 的默认的皮肤，如下图： ? 这次升级后，以后再编写文档就比较简单了。
1.6K20发布于 2018-05-28 - 来自专栏张善友的专栏
微软开源全新的文档生成工具DocFX
Visual Studio的无缝内使用docfx。 注：官方docfx.msbuild的NuGet包现在在预发布版本。您也可以使用源代码编译，并在本地使用它。 有一篇文档详细介绍了如何使用docfx： Getting Started with docfx，具体怎么使用请看这篇文章, 这里还有个OpenLiveWriter 的例子 Use docfx to auto-generate Q: docfx的输入和输出是什么？ A: docfx metadata需要源代码来生成文档元数据，docfx build使用文档元数据+普通md文件生成文档（html） Q: docfx支持定制模板么？ A: 是的，可以参考文档 Q: docfx跨平台么？ A: docfx支持在dnx下运行。
1.6K80发布于 2018-01-29 - 来自专栏林德熙的博客
docfx 做一个和微软一样的文档平台 下载安装创建文档文件生成文档查看文档添加文档添加代码文档做自己的修改忽略不使用的api继续在微软上开发
微软文档使用的工具是 docfx ，这是一个很好的工具。 输入这个命令会生成docfx_project，这里就是新建的文件，可以看到 docfx.json ? 这个文件就是设置文件，可以打开看一下 生成文档 现在就可以进行生成文档了，因为默认就有一些文档。 在cmd输入下面命令，因为这里的 cmd 没进入 docfx_project ，路径就是这样 docfx docfx_project/docfx.json 可以看到创建了 _site ，这里就是网页 首先关闭 cmd 再打开，生成文档 docfx.exe ./docfx.json ? docfx metadata .
2K10发布于 2018-09-18 - 来自专栏痴者工良
docfx 简单使用方法、自动生成目录的工具
[摘要] 这是我编写的一个 Docfx 文档自动生成工具，只要写好 Markdown 文档，使用此工具可为目录、文件快速生成配置，然后直接使用 docfx 运行即可。 /docfx/releases 下载后解压压缩包，记录好目录路径。 两个命令 docfx init -q docfx docfx_project\docfx.json --serve // 以实际路径为准 二， 创建 Docfx 项目 使用此命令在目录下初始一个 docfx 项目 docfx init -q -q 这个参数表示忽略询问，直接生成。 生成文档 docfx docfx_project\docfx.json --serve 预览 对于 项目，可以快速生成对象文档、代码文档。
1.7K20发布于 2021-04-26 - 来自专栏企鹅号快讯
入门干货之用DVG打造你的项目主页-Docfx、Vs、Github
Docfx，类似JSDoc或Sphinx，可以从源代码中提取注释生成文档之外，而且还有语法支持你加入其他的文件链接到API添加额外的说明，DocFX会扫描你的源代码和附加的文件为你生成一个完整的HTML docfx生成默认环境的那个地方有点不妥，不能覆盖文件夹。 0x03、搭建环境 1、VS，得有Github扩展。 2、有Github账号 3、下载docfx,配置环境变量(让你的命令行能找到docfx.exe) 4、接下来，咱就走一种情况，尽量能覆盖你所有的操作的情况。 5、你敲完了之后会有一个新的文件夹叫：“docfx_project”, 别害怕，把里面你的东西都剪切出来，放到外面(就是你clone出来的本地文件夹)，然后删掉这个docfx_project文件夹。 其他选项可以意会，参考文档见:http://dotnet.github.io/docfx/tutorial/docfx_getting_started.html 8、生成：PM里敲: docfx .
99460发布于 2018-02-06 - 来自专栏问问计算机
nuget发布的dll没有注释是什么原因
view=vs-2019） 其中提到的DocfX对应的APIDocumentation效果如下，这个公司级的项目中为了便于学习和查找是个非常不错的选择： （图片来自：https://dotnet.github.io /docfx/templates-and-plugins/templates-dashboard.html） 也可以使用sandcastle。
1.1K40发布于 2021-05-08 - 来自专栏DevOps持续交付
dotnet tool：你可能未曾意识到它的强大
docfx: - 描述：docfx 是一个由微软开发的文档生成工具，用于构建 API 文档、技术文章等。 - 安装命令： dotnet tool install -g docfx 2. csys: - 描述：csys 是一个.NET Core命令行工具，用于系统监视和诊断。
65010编辑于 2024-04-26 - 来自专栏FreeBuf
B2R2：一套针对二进制代码分析的实用算法、函数以及工具集
下面给出的是B2R2所需的依赖库列表： 1、System.Reflection.Metadata 2、Microsoft.FSharpLu.Json 3、FParsec API文档 我们当前使用了docfx
89540发布于 2019-10-29 - 来自专栏张善友的专栏
Model Context Protocol (MCP) C# SDK v0.9.0-preview.1 发布
CI/CD 与工具链基建 #862 @Copilot 文档与治理 修复开发文档库中的断链 Markdown 链接，并强制引入基于 DocFX 的持续集成验证流水线。 前者不仅批量修复了 Markdown 中的链接遗漏，还强制引入了针对 DocFX 工具链的持续集成（CI）准入验证机制；后者则由框架专家 @stephentoub 亲手修订了与诸如 、、`` 等核心属性息息相关的源代码级 DocFX 是目前.NET 开源生态内公认的、用于从高维源代码接口以及 Markdown 文档群落中自动化构建生成静态 API 文档的工业级标准引擎平台。 将 DocFX 的文档树构建过程硬性纳入 CI 流水线的守门员环节，代表着开发团队确立了一种不妥协的原则：任何试图修改公共 API 签名、或者由于疏忽导致接口描述缺失而使得 API 文档生成器报告失败的代码合并请求 叠加多项诸如拥抱.NET 9 工具链支持、强力剥离引发潜在类型冲突和降级隐患的 System.Net.Http 历史遗留依赖、以及引入强制执行的严格 DocFX 文档代码持续集成校验网等工程化治理举措
38110编辑于 2026-03-08 - 来自专栏token的技术分享
Blazor资源大全，很棒的Blazor(3)
DevApps.be 的播客 #47 - [法语] DevApps.be 的播客 #47：“Actualités: TypeScript, Uno, Angular, DocFX, Database”。
2.4K40编辑于 2023-10-13 - 来自专栏.NET企业级解决方案应用与咨询
.NET平台系列5 .NET Core 简介
同时，微软也发展了一个建置技术文件的平台docfx， 并运用于 .NET Core 的文件网站。
1.4K20发布于 2021-05-14 AI大模型在软件开发流程中的创新应用与挑战
例如，微软的DocFX工具利用AI技术自动从代码中提取注释，生成API文档，提高了文档的准确性和及时性。
2K10编辑于 2024-11-08- 来自专栏全栈程序员必看
一系列令人敬畏的.NET核心库，工具，框架和软件[通俗易懂]
docfx – 用于构建和发布.NET项目的API文档的工具http://dotnet.github.io/docfx dotnetfiddle – .NET沙箱，供开发人员快速尝试代码和共享代码片段。
22.4K30编辑于 2022-09-13 - 来自专栏数据分析与挖掘
命名实体识别之使用tensorflow的bert模型进行微调
', 'mt4;realtimefutures', '筑金先生', '万和交易', 'mt4;bca银行', 'mcc', '环球快讯', '真宝金融集团;高晟金业;ruishuo;fft;星亘国际;docfx ', 'mt4;realtimefutures', '筑金先生', '万和交易', 'mt4;bca银行', 'mcc', '环球快讯', '真宝金融集团;高晟金业;ruishuo;fft;星亘国际;docfx 易信环球微', '', '维文信', 'realtimefutures', '', '万和交易', 'bca', 'mcc', '环球快讯', '真宝金融集团;高晟金业;ruishuo;fft;星亘国际;docfx ', 'mt4;realtimefutures', '筑金先生', '万和交易', 'mt4;bca银行', 'mcc', '环球快讯', '真宝金融集团;高晟金业;ruishuo;fft;星亘国际;docfx
5.6K20发布于 2020-12-16 - 来自专栏软件开发
DotNet 资源大全中文版（Awesome最新版）
F# Formatting - 从F＃脚本文件，Markdown文档和内联XML或Markdown注释记录F＃和C＃项目的工具 DocFX - 用于构建和发布.NET项目的API文档的工具 DocNet
19.5K82发布于 2018-01-04
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号