仅为公共成员提取 xml 注释

2023-12-25

我使用 xml 注释来记录组件的公共成员以及内部成员和私有成员。我想将生成的文档 xml 文件与组件程序集打包,以便为最终产品启用“丰富”(例如,包含方法、异常和参数描述)的 Visual Studio Intellisense。问题在于,C# 编译器为所有内容(包括内部类、方法、内部枚举的私有字段等)创建文档条目,并且似乎没有切换到“仅公共成员”模式。

现在,我不想查看超过 50 个文件,每个文件中都包含 XX 方法,并删除私有和内部成员的所有注释。即使我这样做了,我也可能不会在自动生成资源文件方面取得太大成功,因为这些强类型资源类会自动注释并且是非公开的。

我的问题是:是否有一些我忽略的选项/标志?如果没有,是否有一些工具可以帮助将公共成员与其他成员分开(在我开始编写代码之前)?


SandCastle 帮助文件生成器有一个选项可以重新创建仅包含方法、属性等配置的访问模式的 xml 文件...

唯一的“缺点”是您必须生成文档。

EDIT

由于很久以前我忘记了我向 SHFB 添加了一个“组件”来生成 XML。

好消息是该组件已包含在 SHFB 中。

您必须将“Intellisense 组件”添加到 SHFB 项目中。然后它将根据配置的 SHFB 项目生成 XML。

欲了解更多信息:SHFB 中的智能感知组件 http://www.ewoodruff.us/shfbdocs/html/5d546511-6aec-455a-ba09-9daffb124c6d.htm

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

仅为公共成员提取 xml 注释 的相关文章

  • 将字符串作为 PChar 从 CSharp 传递到 Delphi DLL

    我正在尝试将字符串从 C 传递到 Delphi 构建的 DLL Delphi DLL 需要 PChar 这是Delphi导出 procedure DLL Message Location PChar AIntValue integer st
  • 将公历日期转换为儒略日期,然后再转换回来(随着时间)

    我正在编写一个程序 必须将当前的公历日期和时间转换为儒略日期 然后再转换回公历门 最终我需要添加能够添加年 月 日 小时 分钟和秒的功能 但我需要先解决这部分问题 现在我已经从公历日期转换为儒略日期 所以从逻辑上讲 我觉得我应该能够以某种方
  • Dapper 在执行时挂起

    我有一个 IDb连接 sql UPDATE 表名 SET json json lastupdate SYSDATE WHERE id id var param new DynamicParameters param Add json jso
  • 如何在C中同时运行两个子进程?

    所以我开始学习并发编程 但由于某种原因我什至无法掌握基础知识 我有一个名为 fork c 的文件 其中包含一个 main 方法 在此方法中 我将 main 分叉两次 分别进入子进程 1 和 2 在孩子 1 中 我打印了字符 A 50 次 在
  • ContentDialog 未与 UWP 中心对齐

    据我所知 ContentDialog的默认行为应该是使其在 PC 上居中并在移动设备上与顶部对齐 但就我而言 即使在 PC 上我也将其与顶部对齐 但我不明白发生了什么 我正在使用代码隐藏来创建它 这是我正在使用的代码片段 Creates t
  • 如何将 Q 格式整数转换为浮点数(反之亦然)?

    我四处搜寻 找不到一个很好的问题来回答这个问题 给定一个整数 使用Q Format https en wikipedia org wiki Q number format 如何将该数字转换为普通浮点类型 反之亦然 如何将浮点类型转换为Q F
  • 在c#中获取没有时间的日期

    我的表上有一列 缺勤日期时间 日期 当我想要获取包含日期的行时 它返回 0 行 这是我的 C 代码 DateTime ClassDate DateTime Parse lblDate Content ToString var Abs dbs
  • 如何将STL容器数据转储到gdb中?

    我无法在 gdb 中转储 STL 无序映射容器值 变量类型是 std unordered map var 我的 gdb 版本 7 7 1 GDB配置 configure host x86 64 linux gnu target x86 64
  • 应用程序处于中断模式。您的应用程序已进入中断状态,

    我发现自己遇到了同样的问题here https stackoverflow com questions 36204009 disable break mode page in vs2015 我在 dll 中使用 Windows 窗体 这是针
  • Type.MakeByRefType 的反义词是什么

    The Type MakeByRefType http msdn microsoft com en us library system type makebyreftype aspx NET 中的方法返回类型的 by ref 版本 例如传递
  • 如何让XmlReader读取C#中的属性?

    我有一个 XML Stream 其中包含以下 XML 内容
  • 如何使用默认电子邮件客户端发送电子邮件?

    我想使用系统的默认电子邮件客户端 雷鸟 outlook 等 从 net windows 窗体应用程序发送电子邮件 我想预设主题和正文 我认为有一种方法可以通过向 Windows 资源管理器发送类似的内容来做到这一点 mailto 电子邮件受
  • 当需要不同数量和类型的参数时如何创建操作委托列表

    我们有一组大约两打的类 它们继承自具有抽象 Validate 方法的基类 当然 每个类都有不同的验证需求 但它们之间的不同组合需要规则 因此 正如您可以想象的那样 这导致了大量代码重复 例如 A 类需要规则 1 3 6 和 9B 类需要规则
  • 如何在 C# 中更改公共 IP 地址

    我正在创建一个 C winform 应用程序 我想在其中更改公共 IP 地址 而不是像 Hotspot Shield ZenMate OpenVPN 等那样更改 IPv4 地址 我已经检查了以下链接 但没有找到足够的帮助 所以我发布了这个问
  • valgrind 在 Raspberry Pi 上返回未处理的指令

    我最近一直在尝试在运行 Debian GNU Linux7 0 喘息 的树莓派 型号 b 上使用 valgrind 来调试分段错误 每次我在编译的 C 程序上运行 valgrind 时 都会得到类似以下内容的信息 disInstr arm
  • 如何检测应用程序正在运行的 .NET 版本?

    我尝试使用Environment Version ToString 确定目标计算机上正在使用什么 NET 框架 但安装了 4 0 版本时 它说我正在使用 NET 2 0 如何检测目标计算机上正在运行的 NET Framework 版本 En
  • 如何在c#中创建多线程

    我需要监听机器中的所有串行端口 假设我的机器有 4 个串行端口 我必须创建 4 个线程并开始分别使用附加线程监听每个端口 我使用此代码来获取我的机器中的端口数量 private SerialPort comPort new SerialPo
  • 如何在 C 中创建最低有效位设置为 1 的掩码

    这个功能如何运作 最低有效 n 位设置为 1 的掩码 Example n 6 gt 0x2F n 17 gt 0x1FFFF 我根本不明白这些 尤其是 n 6 gt 0x2F 另外 什么是面膜 通常的方法是采取1 并将其左移n位 这会给你类
  • 将一个 IEnumerable 拆分为多个 IEnumerable

    我是 linq 新手 我需要根据指示器将 Couple string text bool Indicator 类型的 IEnumerable 拆分为多个 IEnumerable 我尝试使用skipWhile 和 TakeWhile 但没有找
  • 如何使用 C# 为 azure devops 变量赋值

    我有 selenium C 测试脚本 可以从浏览器获取令牌 我有两个 azure devops 任务 一个用于执行 selenium 测试 另一个用于执行 API 测试 我想将 selenium 测试获取的令牌传递给 API 测试执行任务

随机推荐

  • CkRest.AddHeader 函数不使用 Chilkat C++ 添加标头(使用 fullRequestBinary PUT 的“Content-MD5”标头)

    我们正在使用 Chilkat 9 5 0 80 C 库 我们无法将某个 HTTP 标头添加到请求中 Content MD5 当我们像这样添加这个标头时 m ckRest AddHeader Content MD5 any value her
  • Google 身份验证/Gapi:未捕获类型错误:无法读取 null 的属性“postMessage”

    祝大家有美好的一天 我正在使用创建一个网络应用程序Angular js 1 5 谷歌身份验证 gapi and 用户界面路由器 我的主要目标是初始化谷歌用户首先 使用解决方法从主要抽象状态 stateProvider state app u
  • 设置网格列/行的最小、最大和默认长度

    我知道新的minmax https developer mozilla org en US docs Web CSS minmax允许指定网格列的最小和最大宽度的函数 然而 当使用此函数时 我不清楚列的 默认 宽度是什么 以及如何指定它 在
  • 在Android上过滤目录中的文件

    在我的应用程序中 我从图库中的文件夹中获取图像并将其保存到数组列表中 现在我只想提取扩展名为 jpg 的文件 我该怎么做 保存到数组列表的代码是 private List
  • 使用 DQL 查询返回外键

    我有一个像这样的 InvoiceItem 实体 Entity class InvoiceItem ManyToOne targetEntity Invoice inversedBy items JoinColumn name invoice
  • grails 2.3:测试应用程序无法识别测试

    我正在使用最近发布的 grails 2 3 0 不幸的是 测试应用程序无法识别测试 这是我为产生问题所做的事情 首先 创建一个新应用程序并创建一个控制器 grails create app firstApp cd firstApp grai
  • glClearColor() 将 iPhone 的渲染利用率推至 27%

    寻找答案的结果是这个问题 https stackoverflow com questions 872560 512x512 texture causing huge gpu stress on iphone despite tiling 我
  • Python:使用minidom搜索具有特定文本的节点

    我目前面临的 XML 看起来像这样
  • 存储来自 Google Places API 的数据

    如果这个问题听起来有点傻 请不要介意 我正在尝试了解有关 Google Places API 的更多信息 我有兴趣做一个类似于airbnb com的实现 检查顶部的搜索功能 它在自动建议中显示 powered by google 在我们的地
  • 2 个给定数字之间的双精度数密度

    重要编辑 最初的问题是关于获取双精度数和分数的密度 当我得到双精度数而不是分数的答案时 我正在改变主题以结束这个问题 原问题的另一半是here https stackoverflow com questions 48245279 densi
  • Win32 防止窗口“折断”

    如何为我的应用程序禁用 Windows 7 的捕捉功能 以编程方式 或者有什么方法可以检测应用程序是否已被捕捉 并专门调用API函数来取消捕捉 调用 SetWindowPos 或 ShowWindow 无法正确取消对齐 SW MAXIMIZ
  • 使用python中的struct模块打包和解包可变长度数组/字符串

    我试图掌握 Python 3 中二进制数据的打包和解包 它实际上并不难理解 除了一个问题 如果我有一个可变长度的文本字符串并且想要以最优雅的方式打包和解包它怎么办 据我从手册中可以看出 我只能直接解压固定大小的字符串 在这种情况下 是否有任
  • MS Access VBA 捕获 SQL Server 连接错误

    我在获取 Access 2010 VBA 来捕获与 SQL Server 2008 连接以链接表的错误时遇到问题 我收到错误并弹出窗口 可能是来自 ODBC 驱动程序 我想抑制这些并自己处理错误 我知道 DAO errors 和 ADO e
  • Jquery 添加值以选择选项

    我已经用谷歌搜索这个选项很多天了 但找不到解决方案 我想要的是 我有两个选择框 第一个选择框有国家 地区名称 第二个选择框为空 我想要的是 当我从第一个选择框中选择任何国家 即英国 时 应该运行 php 查询以从表中获取所有城市名称 然后使
  • 构建 APK - 错误 - app:transformClassesWithDexForDebug

    我在这里看了很多线程 但仍然没有找到有效的解决方案 当我想构建 APK 时 出现以下主要错误 错误 任务执行失败 app transformClassesWithDexForDebug com android build api trans
  • Chartjs 拆分两位数数字

    我已经多次看到这个问题 但我找不到适合我的解决方案 我将 Django 变量传递到 Chartjs 中进行绘图 所有单位数字都是正确的 但它会将两位数变成单位数 就像 11 是 1 1 23 是 2 3 我尝试了很多不同的方法 但无法弄清楚
  • 由于 StackOverflowError,无法完成 Web 应用程序 [/app] 的注释扫描

    我正在使用 STS eclipse 插件 和 maven 开发 Spring MVC 应用程序 为了创建项目 我按照 STS 向导创建了一个新的 Spring MVC 项目 之后 我向其他项目和库添加了一些依赖项 然而 当我现在尝试将项目部
  • -bash:__git_ps1:找不到命令

    我尝试安装 Ruby 2 0 我的命令行出现了问题 现在如下所示 bash git ps1 command not found 11 58 28 whatever whatever 我不知道如何摆脱 git ps1 command not
  • 在 Python 中线程读取串行端口(使用 GUI)

    我想在运行 GUI 时每当有数据要从串行端口读取时触发一个事件 这pySerial模块显然具有实验性功能 但没有特别详细的记录 我找不到任何有用的示例在 API 中 https pyserial readthedocs io en late
  • 仅为公共成员提取 xml 注释

    我使用 xml 注释来记录组件的公共成员以及内部成员和私有成员 我想将生成的文档 xml 文件与组件程序集打包 以便为最终产品启用 丰富 例如 包含方法 异常和参数描述 的 Visual Studio Intellisense 问题在于 C