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

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

开发中,有一句话叫 最不喜欢的是写文档,最不喜欢的是看别人家代码没有文档。那么世界上文档写最 la 好 ji 的就是微软了,那么微软的api文档是如何做的?难道请了很多人去写文档?...可以看到添加文档需要自己写目录,这个不是很好,所以我就写了一个工具来生成。 添加代码文档 api文档是主要的,生成api文档需要安装vs2015以上。...href: api/ homepage: api/index.md 删除得到 - name: Articles href: articles/ - name: Api Documentation...忽略不使用的api 经常有一些api是不希望显示在文档的。...如果要忽略命名空间是 lindexi.laji 的代码,请看下面代码 - exclude: uidRegex: ^lindexi\.laji type:

1.6K10

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

Docfx,类似JSDoc或Sphinx,可以从源代码中提取注释生成文档之外,而且还有语法支持你加入其他的文件链接到API添加额外的说明,DocFX会扫描你的源代码和附加的文件为你生成一个完整的HTML...4、打开PM(程序包管理控制台),在该目录下(注意你当前环境的路径位置),敲命令: docfx init -q 这个命令是让你生成一个默认的文档编辑框架。...当然了还有其他选项比如-o 和上面的操作是一个德行,虽然说可以指定目录,但是不能指定一个存在的目录。...此时你可以向Github上提交一次你的改动。 a、 b、 c、 d、 提交失败的话可能服务器版本中,某些文件比你新,那你就点蓝色的同步。没有就点推送推过去。...,请直接在你的docfx工程里进行本地添加引用。

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

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

    API添加额外的说明,DocFX会扫描你的源代码和附加的文件为你生成一个完整的HTML模版网站,你可以自己通过模版定制,目前已经内嵌了几个模版,包括静态的HTML页面和AngularJS页面。...源代码: https://github.com/dotnet/docfx 文档: http://dotnet.github.io/docfx/ 点击“查看源文件”的API来路由到GitHub的源代码(您的...DFM是Github上 Markdown(GFM),并增加了一些新的功能,包括文件包含 , 交叉引用 ,和YAML头 100%兼容 。...在docfx中,最重要的就是生成文档,把markdown文件(gfm语法)转换成html,微软还开源一个基于gfm的并且很容易扩展的语法的markdown组件 MarkdownLite,代码包含在docfx...FAQ: Q: docfx是什么? A: docfx是一个api文档编译软件,它能根据c#/vb源代码生成对应的文档元数据并生成文档(目前提供html),并支持普通md文件。

    1.3K80

    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...: make 或 dotnet build 项目引用 如果你想要在自己的研究项目中使用B2R2的话,请在项目中添加下列信息: @INPROCEEDINGS{jung:bar:2019, author =

    70640

    授权、鉴权与准入控制

    同样包含对被Bind 的 Role 引用;RoleBinding 适用于某个命名空间内授权,而 ClusterRoleBinding 适用于集群范围内的授权。...将 default 命名空间的 pod-reader Role 授予 jane 用户,此后 jane 用户在 default 命名空间中将具有 pod-reader 的权限: kind: RoleBinding...空间中的 secrets(因为 RoleBinding 定义在 development 命名空间): # This role binding allows "dave" to read secrets...ClusterRole name: secret-reader apiGroup: rbac.authorization.k8s.io 使用 ClusterRoleBinding 可以对整个集群中的所有命名空间资源权限进行授权...上创建对象,防止删除系统预置 namespace,删除namespace 时,连带删除它的所有资源对象 LimitRanger:确保请求的资源不会超过资源所在 Namespace 的 LimitRange

    1.2K10

    Java 中文官方教程 2022 版(四十)

    请注意,命名空间被视为属性,尽管在游标和迭代器 API 中,命名空间与属性分开报告。还要注意,命名空间处理对于 StAX 处理器是可选的。...绑定前缀可以通过传递前缀的实际值,使用setPrefix方法,或设置默认命名空间声明的属性来处理。...方法可用于显式绑定输出时使用的前缀,而 getPrefix(...) 方法可用于获取当前前缀。请注意,默认情况下,XMLEventWriter 会将命名空间绑定添加到其内部命名空间映射中。...在这个示例中,与事件示例中的对象流一样,命名空间前缀被添加到 HTML 标签的开头和结尾。虽然 StAX 规范不要求添加这个前缀,但是当输出流的最终范围不明确时,这是一个良好的实践。...,包括元素名称、属性名称和命名空间前缀和 URI。

    11500

    【Python】Python模块基础

    import首次导入模块发生了3件事: 以模块为准创造一个模块的名称空间 执行模块对应的文件,将执行过程中产生的名字都丢到模块的名称空间 在当前执行文件中拿到一个模块名 注意:模块的重复导入会直接引用之前创造好的结果...,意味着可以不用加任何前缀而直接使用 优点:不用加前缀,代码更加精简 缺点:容易与当前执行文件中名称空间中的名字冲突 # run.py from spam import money from spam...1、当run.py运行的时候,aaa.py被当做引用模块,它的name == 'aaa'(模块名),会执行aaa.py中的f1()。...在导入一个包的时候,Python 会根据 sys.path 中的目录来寻找这个包中包含的子目录。...假设你要写一个ATM软件,你可以按照下面的目录结构管理你的软件代码: ATM/ |-- core/ | |-- src.py # 业务核心逻辑代码 | |-- api/ | |-- api.py # 接口文件

    1.8K30

    Java 中文官方教程 2022 版(三十八)

    第二行指定了要用于文档中没有命名空间前缀的元素的模式,即通常在任何简单、不复杂的 XML 文档中定义的元素。...第二行指定了要用于文档中没有命名空间前缀的元素的模式-也就是,通常在任何简单、不复杂的 XML 文档中定义的元素。(您将看到如何处理多个命名空间在下一节中。)...数据集可能包括来自税务申报表和雇员入职表的信息,两个元素在各自的模式中都命名为form。 如果为税务命名空间定义了一个前缀,并为雇佣命名空间定义了另一个前缀,则人员数据可能包括以下部分。...新的是中间的条目,它定义了文档中引用的每个命名空间要使用的模式的位置。...请注意,在定义模式位置时不能使用命名空间前缀。xsi:schemaLocation声明只能理解命名空间名称,而不能理解前缀。

    8500

    -利用配置文件开始工作

    由于框架可以确切地了解配置文件所在目录的的位置,从而不必扫描文件系统中的不同区域;故而在我们的项目中,使用命名空间将会有效地提升性能。...当这种情况发生时,系统将没有办法获知这个变量所对应的确切的值。 我们可以通过将这些变量放入”命名空间“中,来放置这一情况的出现。 在配置文件中,点号(.)通常被用来表示一个变量是命名空间变量。...这种变量通常是由一个独立前缀,后接一个点号(.)然后才是变量名称本身所组成的: // 非命名空间变量 name = "George" db=my_db // 命名空间变量 address.city =...如果一个命名空间变量的前缀(以大小写敏感的方式)可以正确匹配到配置类的名称,那么这个变量名的剩余部分(点号后面的部分)将会被当做一个配置项属性。...如果一个命名空间环境变量的前缀与某个配置类所匹配,那么这个变量的剩余部分,若同样包含点号,则将会被当做一个数组的引用来调用: // 常规的命名空间变量 SimpleConfig.name = George

    1.2K20

    Node对象

    Node对象 Node是一个接口,各种类型的DOM API对象会从这个接口继承,其允许我们使用相似的方式对待这些不同类型的对象。.../之前的文件目录。...Node.prototype.isDefaultNamespace(): 返回一个Boolean类型值,接受一个命名空间URI作为参数,当参数所指代的命名空间是默认命名空间时返回true,否则返回false...Node.prototype.lookupPrefix(): 返回包含参数URI所对应的命名空间前缀的DOMString,若不存在则返回null,如果存在多个可匹配的前缀,则返回结果和浏览器具体实现有关...Node.prototype.lookupNamespaceURI(): 接受一个前缀,并返回前缀所对应节点命名空间URI,如果URI不存在则返回null,传入null作为prefix参数将返回默认命名空间

    55250

    使用向量数据库构建注重隐私的AI软件

    将命名空间视为索引中的特定于实体的分区。如果索引是用户,则每个命名空间都可以映射到每个用户的名称。每个命名空间仅存储与其用户相关的数据。...使用命名空间还可以通过减少在返回相关结果时需要搜索的总空间来帮助提高查询性能。...使用 ID 前缀查询内容片段 Pinecone 支持 ID 前缀,这是一种在 upsert 时将额外数据附加到向量的 ID 字段的技术,以便您稍后可以引用内容的“片段”,例如第 1 页、第 23 块中的所有文档...ID 前缀允许我们隔离、标记并稍后列出或删除特定于实体的数据。这使我们能够将 RAG 扩展到一个架构中,该架构提供了有关数据删除的保证。...向量数据库中的数据保留和删除 如果您遵循通过维护单独的命名空间来实现多租户的建议惯例,则可以通过单个操作方便地删除存储在该命名空间中的所有内容。

    11210

    带你学习hyperf-3.1路由

    3.1路由 路由所处的目录 cd config/routes.php Bash Copy 定义路由的方式:在路由文件里为某个控制器注册路由 - 接收方法: - get:获取数据 - post...:新增数据 - put:更新该数据的所有内容 - patch:更新该数据的局部内容 - delete:删除该数据 - 参数定义:(定义了参数后url上的路径必须以 / 结尾,否则不能访问...) - {id}:必选 - [{id}]:选填 - 组的定义:addGroup,第一个参数是路有前缀,必须以 / 开头 - 中间件:定义在路由方法中的第三个参数中,(addRoute是第四个参数...; 命名空间; 使用 @GetMapping 注解时需 use HyperfHttpServerAnnotationGetMapping; 命名空间; 使用 @PostMapping 注解时需...; 命名空间; 使用 @PatchMapping 注解时需 use HyperfHttpServerAnnotationPatchMapping; 命名空间; 使用 @DeleteMapping

    1.3K10

    PSR-4 自动加载规范

    下划线在全限定类名中没有任何特殊含义(在 PSR-0 中下划是有含义的)。 全限定类名可以是任意大小写字母的组合。 所有类名的引用必须区分大小写。...全限定类名的加载过程 在全限定的类名(一个 命名空间前缀)中,一个或多个前导命名空间和子命名空间组成的连续命名空间,不包括前导命名空间的分隔符,至少对应一个根目录。...命名空间前缀后面的相邻子命名空间与根目录下的目录名称相对应(且必须区分大小写),其中命名空间的分隔符表示目录分隔符。...范例 下表显示了与给定的全限定类名、命名空间前缀和根目录相对应的文件的路径。...完全限定的类名 命名空间前缀 基本目录 结果文件路径 \Acme\Log\Writer\File_Writer Acme\Log\Writer ./acme-log-writer/lib/ .

    37210

    PHP规范PSR0和PSR4的理解

    每个命名空间(namespace)中可以根据需要使用任意数量的子命名空间(sub-namespace)。...; 下划线在完全限定类名中是没有特殊含义的; 字母在完全限定类名中可以是任何大小写的组合; 所有类名必须以大小写敏感的方式引用; 当从完全限定类名载入文件时: 在完全限定类名中,连续的一个或几个子命名空间构成的命名空间前缀...(不包括顶级命名空间的分隔符),至少对应着至少一个基础目录。...在「命名空间前缀」后的连续子命名空间名称对应一个「基础目录」下的子目录,其中的命名 空间分隔符表示目录分隔符。子目录名称必须和子命名空间名大小写匹配; 终止类名对应一个以 .php 结尾的文件。...但是这里有些例外,类名中的下划线在PSR4中是不需要转换成目录的。 使用PSR4,我觉得有2个好处: 1. 减少代码目录的深度 2. 可以通过前缀快速找到映射目录,提高自动加载的效率

    1.3K20

    Android:Tools命名空间原来是有大用处的

    一、tools 命名空间是啥?在哪里有?...在Android Studio 中,我们创建一个 xml 布局文件之后,通常在自动生成的代码中,会有一个 tools 命名空间: xmlns:tools="http://schemas.android.com...之前一直不知道是干嘛用的,从来没有用过,然后要么手动删除,要么格式化代码的时候就自动把它删除了。直到今天翻看文档时才发现,这玩意儿竟然有大用途! 二、tools 命名空间的作用有哪些?...三、tools 命名空间属性功能详解 该部分内容是基于官方文档的总结整理,由于个人水平有限,理解可能会有偏差,欢迎指正 (一)、xml 中的错误处理属性 1、tools:ignore ....以tools 为命名空间的属性值只在预览时有效。

    1.7K40

    Kubernetes之RBAC权限管理

    ClusterRoleBinding 将角色中定义的权限赋予一个或者一组用户,针对集群范围内的命名空间执行授权。 在 RBAC API 中,一个角色包含一组相关权限的规则。...一个 RoleBinding 可以引用同一的命名空间中的 Role 。...=acme:myapp --namespace=acme 在命名空间 "acme" 中,将名为 view 的 ClusterRole 对象中的权限授予命名空间 "myappnamespace" 中名称为..., 保留角色中的其余权限和绑定中的其他主体: kubectl auth reconcile -f my-rbac-rules.yaml 应用 RBAC 对象的清单文件, 删除角色中的其他权限和绑定中的其他主体...命令kubectl auth reconcile可以创建或者更新包含 RBAC 对象的清单文件, 并且在必要的情况下删除和重新创建绑定对象,以改变所引用的角色 10.

    5.5K81
    领券