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

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

微软放弃Sandcastle有些年头了,微软最近开源了全新的文档生成工具DocFX,目前支持C#和VB,类似JSDoc或Sphinx,可以从源代码中提取注释生成文档之外,而且还有语法支持你加入其他的文件链接到...API添加额外的说明,DocFX会扫描你的源代码和附加的文件为你生成一个完整的HTML模版网站,你可以自己通过模版定制,目前已经内嵌了几个模版,包括静态的HTML页面和AngularJS页面。...在docfx中,最重要的就是生成文档,把markdown文件(gfm语法)转换成html,微软还开源一个基于gfm的并且很容易扩展的语法的markdown组件 MarkdownLite,代码包含在docfx...FAQ: Q: docfx是什么? A: docfx是一个api文档编译软件,它能根据c#/vb源代码生成对应的文档元数据并生成文档(目前提供html),并支持普通md文件。...A: 是的,可以参考文档 Q: docfx跨平台么? A: docfx支持在dnx下运行。

1.3K80

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

最近使用 DocFX 对 Rafy 框架的帮助文档进行了升级。...关于 SandCastle 的具体使用方法,可以见:《文档API生成神器SandCastle使用心得》。 DocFX 最近两年,MS 自家的帮助文档大变样,例如 MSDN:《C# Guide》。...其使用的就是最新的文档编写、生成工具:DocFX。DocFX 的网址:http://dotnet.github.io/docfx/。...- 产品线工程: 插件化业务模块积累(内置一个权限控制插件模块)、客户化二次开发、实施配置平台。 - 一套代码,可同时生成并运行 C/S、单机版、B/S 三种应用程序。...同时集领域驱动设计、面向服务架构、模型驱动架构、产品线工程方法于一身,是 Rafy 框架中其它组件(如界面生成等高级功能)的基础。 包含以下程序集: * Rafy.dll 2.

1.4K20
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

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

    开发中,有一句话叫 最不喜欢的是写文档,最不喜欢的是看别人家代码没有文档。那么世界上文档写最 la 好 ji 的就是微软了,那么微软的api文档是如何做的?难道请了很多人去写文档?...我需要在一个文件夹包含多个项目的情况下,以及包含多个文件夹,里面包含多个项目的情况,可以解析出他们的文档和代码。...于是程序就获取配置的文件,从文件获取到存在哪些文件夹是需要进行转换的。 然后 遍历整个文件夹,获取文件夹里的配置,从而得到需要进行做的文件夹。...如果文件夹里的配置出错了,如找不到文件或其他的错误,那么报告为警告就好。...程序可以从所有的文件夹获取配置,如果一个文件夹存在配置文件: docfx.json 那么读取配置文件里存在哪些配置文件,其中,文件的格式为: Src: - E:\12 Doc: E:\123123 DocfxFolder

    1.6K10

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

    Docfx,类似JSDoc或Sphinx,可以从源代码中提取注释生成文档之外,而且还有语法支持你加入其他的文件链接到API添加额外的说明,DocFX会扫描你的源代码和附加的文件为你生成一个完整的HTML...2、有Github账号 3、下载docfx,配置环境变量(让你的命令行能找到docfx.exe) 4、接下来,咱就走一种情况,尽量能覆盖你所有的操作的情况。...4、打开PM(程序包管理控制台),在该目录下(注意你当前环境的路径位置),敲命令: docfx init -q 这个命令是让你生成一个默认的文档编辑框架。...7、改文件:打开:docfx.json metadata节点下:src/files的内容 改成 "src/**.cs". 这个就是寻找你的C#文件,然后帮你生成接口页面。...\docfx.json --server ,然后去docs 文件夹里看看效果: 9、配置Github, 当前代码库的页面上面有个Setting-往下拉找到Github Page-选那个带有docs的选项

    86060

    C#语法——事件,逐渐边缘化的大哥。

    最常见的事件用途是窗体编程,在Windows窗体应用程序和WPF应用程序中。 当在窗体中点击按钮,移动鼠标等事件时,相应的后台程序会收到通知,再执行代码。...二,一个类,用存储事件的数据。即,事件要定义在类中。 下面我们来为这个事件赋值。...系统提供事件 C#的框架都很经典,而每个经典框架都为我们提供了一些经典事件。 由于事件必须[标识响应方法的委托],所以这些事件所使用的委托都有一个共同的特点,命名中包含Event。...sender:代表源,即触发该事件的控件。 e:代表事件参数,即触发该事件后,事件为被触发的委托,传递了一些参数,以方便委托在处理数据时,更便捷。 根据这个原理,我们可以分析出很多东西。...原因很简单,学习的过程中尽量降低概念混淆。而且,在C#开发中,好的架构者也通常会将事件和委托分离,所以,就认为事件和委托没有关系即可。 结语 其实事件很好理解,一点不复杂。

    1.7K30

    .NET周刊【12月第3期 2024-12-15】

    C#委托的前世今生 https://www.cnblogs.com/xiketangedu/p/18594690 这篇文章介绍了C#中的委托概念及其在多线程中的应用。...该项目被评为优秀C#/.NET/.NET Core项目,适合希望提高PDF文档处理效率的用户。...当数据源为 List 时,需要手动实现排序。在事件中,通过列索引获取属性名,然后按此属性进行升序或降序排序。使用泛型获取属性值的方法可实现灵活处理。...我尝试过 - Qiita 使用 C# 创建 Excel 插件 - Qiita 在 C# 中插入文档注释 - Qiita [VB.NET] 尝试使用.NET 9 中添加到 LINQ 的方法 - Qiita...assembly) 在 C# 中使用矢量化来提高性能 避免在 ASP.NET Core 应用程序中使用 C# 事件 认识 TUnit:新的、快速的、可扩展的 .NET 测试框架 · Sander 十

    7810

    Unity引擎基础知识

    在Unity引擎中优化大型游戏项目的性能可以从多个方面入手,以下是一些详细的建议: 内存管理: 合理使用ScriptableObjects来存储不占内存的配置数据,避免频繁加载和卸载。...委托与Lambda表达式:委托是一种类型安全的函数指针,而Lambda表达式提供了一种简洁的方式来定义匿名函数。这些技术在事件处理、多播委托等场景中非常有用。...事件处理:事件处理机制允许对象之间松耦合地通信,是设计模式中的观察者模式的基础。 冒泡排序算法:虽然简单,但冒泡排序算法是理解基本排序算法的好例子,有助于学习更复杂的排序算法。...多播委托和观察者设计模式:多播委托允许多个订阅者同时订阅同一个事件,而观察者设计模式是一种发布-订阅模式,常用于事件驱动系统。...在设计高级UI时,需要考虑如何将用户界面与游戏逻辑相结合。这包括响应用户的点击、拖动等操作,并执行相应的游戏内行为。通过学习如何在Unity中实现对象交互,可以增强玩家的参与度和沉浸感。

    13510

    委托表示回调

    需转载请联系 494324190@qq.com 回调是一种由服务端提供一部反馈的机制,它在某些情况下会涉及到多线程或者为同步更新提供入口,在 C# 中如果要编写良好的回调那么就必须用委托来表示回调。...委托我们经常用在事件处理的时候,我们也可以将委托用在其他地方,例如我们像以送伞的方式在类和类之间沟通的话,我们就可以使用委托,这是因为委托可以定义类型安全的回调可以在运行的时候配置回调目标,并且可以向多个客户端发出通知...委托其实是一种对象,它包含指向方法的引用。所指向的方法既可以是静态的又可以是实例方法,在程序运行时可以配置一个或多个客户对象进行通信。...C# 为我们提供了一种简单的方法来使用委托和回调,这种方法就是 lambda 表达式 ,同时在 .NET 中很多委托形式使用的是 Predicate 、 Func 和 Action 。...Tip:我们常用的 LINQ 就是以委托为基础构建的,回调则用于处理 WPF 和 WinForm 中的跨线程封送。

    87740

    net开发高级面试题2021_net面试题2021

    C#中的委托是什么?事件是不是一种委托?事件和委托的关系。 4.9. override 与重载(overload)的区别 4.10. 什么是装箱(boxing)和拆箱(unboxing) 1....3.12. dot net core 里面的路径是如何处理的? 路径处理是用来为进入的请求寻找处理函数的机制。所有的路径在函数运行开始时进行注册。...internal: 当前程序集内可以访问。 4.8. C#中的委托是什么?事件是不是一种委托?事件和委托的关系。 委托可以把一个方法作为参数代入另一个方法,可以理解为指向一个函数的指针。...换个说法来解释,委托就是函数指针,事件就是保存多个函数指针的数组。 事件和委托的区别如下: 事件只能在方法的外部进行声明,而委在方法的外部和内部都可以声明。...事件只能在类的内部触发,不能在类的外部触发。而委托在类的内部和外都都可以触发。 委托一般用于回调,而事件用于外部接口。例如在观察者模式中,在被观察者中可以声明一个事件作为外部观察者注册的接口。

    3.3K10

    每个.NET开发都应掌握的C#委托事件知识点

    其中,委托和事件是C#中不可或缺的关键概念,每个.NET开发者都应该深入理解它们的作用和用法。...通过事件,对象可以在不直接依赖于其他对象的情况下,将重要信息传递给感兴趣的观察者。 下面将用一个案例来理解委托和事件 为了更好地理解委托和事件,我们可以以一个简单的温度监测系统为例。...class TemperatureMonitor { // 定义事件,将委托作为事件处理程序 public event TemperatureChangeHandler TemperatureChanged...在这个示例中,TemperatureMonitor 类充当了被观察者(发布者),Program 类中的 OnTemperatureChanged 方法充当观察者(订阅者) 结语 委托和事件是C#中的重要概念...,在C#中无论是实现回调机制、处理异步操作,还是实现事件驱动的架构,委托和事件都是不可缺的,每个.NET开发者都应该深入了解和熟练掌握。

    27210

    ·方法

    所谓匿名方法,就是没有名字的方法体,他是通过委托来完成。直接在委托后面写程序块作为方法体。     ...b; }; //匿名方法通过委托绑定事件 ·Lambda表达式   Lambda表达式可以简化匿名方法传给委托变量。   ...以下代码编译会报错:“无法将 lambda 表达式 转换为预期委托类型,因为块中的某些返回类型不可隐式转换为委托返回类型 ”,因为签名不一样。   ...:Lambda 表达式 - C# 引用 | Microsoft Docs   建议大家多看看官方文档,确实总结的很好。...·构造函数   构造函数的表达式主体定义通常包含单个赋值表达式或一个方法调用,该方法调用可处理构造函数的参数,也可初始化实例状态。

    72670

    .NET周刊【11月第3期 2024-11-17】

    NET 9 包含众多新功能和改进,详情见官方公告和技术文档。 .NET现在可以做什么,有哪些公司在用的?...elsa-core被收录到C#、.NET等优秀项目中,在GitHub和Gitee可访问其源代码和文档。DotNetGuide技术社区为.NET开发者提供交流和学习平台,欢迎加入。...开发者可使用统一接口处理文件和目录,不用关注存储位置,提升应用程序灵活性。该程序代码展示了如何配置和使用 ABP 模块及语言本地化。...由C#委托回调想到的二三事 https://www.cnblogs.com/geekfrank/p/18548348 在开发过程中,使用UserControl封装界面模块有利于应对需求更改。...绑定事件时,要解除委托以释放资源,CLR的垃圾回收基于代机制,自动管理不再被访问的资源。

    8410

    为什么委托的减法(- 或 -=)可能出现非预期的结果?(Delegate Subtraction Has Unpredictable Result)

    然而在写为事件写 -= 的时候却并没有这样的提示。然而这个提示是什么意思呢?为什么会“非预期”?为什么委托会提示而事件不会提示? 阅读本文将了解委托的减法。 ---- ?...▲ 委托的减法可能出现非预期的结果 ReSharper 的官方帮助文档 例子和现象 从 ReSharper 的提示中,我们可以跳转到官方帮助文档 Code Inspection: Delegate subtractions...官方文档中给出了一个非常典型的 Demo 程序: static void Main() { Action a = () => Console.Write("A"); Action b...,而事件必须定义在类中。...至少从设计模式上说,事件里委托减法的的那些非预期就忽略吧,那么没有定义成事件的那些委托呢?我们需要如何处理减法?

    1K10

    .NET周刊【1月第3期 2025-01-19】

    C#钩子(Hook) 捕获键盘鼠标所有事件 - 5分钟没有操作,自动关闭 Form 窗体 https://www.cnblogs.com/vipsoft/p/18668517 本文讲述C#中的钩子技术,...文章说明了如何定义和调用异步方法,以及异步编程在I/O密集型操作、UI应用程序和Web应用程序中的应用场景。...它支持自然语言查询,能从已索引数据中获取答案,并提供完整引用。KM 能与 .NET 应用集成,提升文档识别能力。用户可将 KM 作为服务,异步处理问题与文档。...它的API简洁易用,支持RFC 6455中的所有核心功能,包括文本和二进制传输、Ping/Pong机制等。它采用事件驱动方式进行消息处理,支持异步编程,性能高效,允许灵活的配置以满足不同需求。...每个中间件对请求处理后将其传递给下一个,直到最终处理程序。管道的工作流程分为请求和响应两个阶段,利用委托和上下文机制实现。

    6410

    CA1003:使用泛型事件处理程序实例

    的类型),而且包含程序集面向的是 .NET。...规则说明 在 .NET Framework 2.0 之前,为了将自定义信息传递到事件处理程序,必须将新委托声明为指定派生自 System.EventArgs 类的类。...在 .NET Framework 2.0 及更高版本中,泛型 System.EventHandler 委托允许将所有派生自 EventArgs 的类与事件处理程序一起使用。...配置代码以进行分析 使用下面的选项来配置代码库的哪些部分要运行此规则。 包含特定的 API 图面 你可以仅为此规则、为所有规则或为此类别中的所有规则配置此选项(设计)。...在 Visual Basic 示例中,注释说明了如何修改示例以符合规则。 对于 C# 示例,下面的示例演示了修改后的代码。

    52220

    WPF开发-委托(delegate)

    当实例化委托时,您可以将其实例与任何具有兼容签名的方法相关联。 您可以通过委托实例调用方法。 委托用于将方法作为参数传递给其他方法。 事件处理程序就是通过委托调用的方法。...您可以创建一个自定义方法,当发生特定事件时某个类(例如 Windows 控件)就可以调用您的方法。 委托在C#中是一个语言级特性,而在Java语言中没有直接的对应,但是java利用反射即可实现委托!...委托可以链接在一起;例如,可以对一个事件调用多个方法。 方法不必与委托签名完全匹配。 有关更多信息,请参见 在委托中使用变体(C# 和 Visual Basic))。...在以下情况下,请使用委托: 当使用事件设计模式时。 当封装静态方法可取时。 当调用方不需要访问实现该方法的对象中的其他属性、方法或接口时。 需要方便的组合。 当类可能需要该方法的多个实现时。...声明、实例化和使用委托 C# 1.0 及更高版本中,可以按以下示例所示声明委托。

    2K20

    C# 的一些关键高级特性

    C# 是一种现代、通用、面向对象的编程语言,由微软在 .NET 平台上开发。自 2000 年首次发布以来,C# 已经发展出许多高级特性,使其成为开发各种应用程序的强大工具。...异步编程与 async 和 await 关键字 背景 在现代应用程序中,异步编程非常重要,尤其是在处理 I/O 操作时,如读取文件、访问网络资源或与数据库交互。...委托和事件 背景 委托是 C# 中的一种类型安全的函数指针,允许开发者将方法作为参数传递。事件是基于委托的一种特殊机制,用于在对象之间实现松散耦合的消息传递。...在 Process 类中,当进程完成时触发 ProcessCompleted 事件,并在 Program 类中订阅该事件,从而实现事件驱动的编程模型。 7....set 访问器中包含验证逻辑,以确保名称不为空。 8. 可空类型(Nullable Types) 背景 在实际开发中,我们经常需要处理可能为空的值。

    2.5K41

    C#中事件(event)

    事件基于委托,为委托提供了一种发布/订阅机制。在Windows应用程序中Button类提供了Click事件。触发Click事件时调用的处理程序方法需要定义,其参数由委托类型定义。...C#中使用事件需要如下步骤: (1)创建一个委托 (2)将创建的委托与特定事件关联(.NET类库中的很多事情都是已经定制阿红的,所以它们也就有相应的一个委托,在编写关联事件处理程序的时候我们需要和这个委托有相同的签名...{ /* * EventArgs是包含事件数据的类的基类,此类不包含事件数据,在事件引发时不向事件处理程序传递状态信息的事件会使用此类。...*/ /// /// 因为在我们键盘按键事件中要包含按键信息,所以要派生一个KeyEventArgs类, /// 来保存按键信息,好让后面知道按了哪个键。...,并将事件交由KeyDownHandler这个委托来处理 //参数this是指触发事件的对象就是本身这个对象,keyEventArgs包含了按键信息。

    2.2K30
    领券