xml-documentation 相关问题

XML文档是从代码内的注释生成自动文档的方法,以及可以用任何方法显示的XML格式文件,例如,一个网页。

C# 文档链接到方法,但仅显示不带参数的方法名称

我想显示仅包含方法名称作为文本的链接。有没有办法设置方法链接并更改文本?这就是我所知道的: 当你悬停时......

回答 1 投票 0

为什么 C# 编译器在 XML 文档中包含非公共成员?

使用 csc.exe 编译源代码时,可以使用 /doc 选项将源文件中的 xml 文档注释保存到外部 xml 文件。 我想知道的是为什么

回答 2 投票 0

Visual Studio XML 单行摘要注释

在 Visual Studio 中,如何将默认 XML 摘要注释片段从三行更改为一行? 目前,当我输入 /// 时,它会提供此片段: /// /// /// 在 Visual Studio 中,如何将默认 XML 摘要注释片段从三行更改为一行? 目前,当我输入 /// 时,它会提供此片段: /// <summary> /// /// </summary> 我想要这个较短的片段: ///<summary></summary> 我的总结通常很简短,多余的两行是不必要的。 是否有针对此问题的配置设置或某些可自定义代码/自定义插件来解决此问题。 这是一个较旧的问题,但我喜欢 Jason Williams 为此创建一个片段的建议,所以我这样做了。 不是很复杂,但是复制粘贴更容易:) <?xml version="1.0" encoding="utf-8"?> <CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet"> <CodeSnippet Format="1.0.0"> <Header> <Title>Single line summary</Title> <Shortcut>summary</Shortcut> </Header> <Snippet> <Code Language="csharp"> <![CDATA[/// <summary>$end$</summary>]]> </Code> </Snippet> </CodeSnippet> </CodeSnippets> 您可以通过(可能很明显)更改 <Shortcut> 值来更改快捷方式。 将其粘贴到名为 SingleLineSummary.snippet 的新文件中,并将其保存在文件夹 %USERPROFILE%\Documents\Visual Studio 2012\Code Snippets\Visual C#\My Code Snippets 中(进行修改以适合您的 Windows 和 Visual Studio 版本)。 如果您不熟悉代码片段,要使用它,只需将光标放在方法/属性/等上方,开始输入 summary,然后按 TAB 几次。 我个人认为这应该是VS编辑器本身的一部分。我知道过去曾有人要求过。 与此同时,片段想法是一个很好的想法,但行为略有不同。 如果您想保持相同的行为并且愿意购买第 3 方附加组件,那么 SubMain 有一款名为“GhostDoc Pro”的产品,只需付出一点努力,即可为您做到这一点。 (请注意,他们有一个免费的非“专业”版本“GhostDoc”,但我认为它不会起作用。) 如果您想走这条路,请按照以下方式操作。 安装 GhostDoc Pro 后,转到“工具”菜单。顶部将是一个新的弹出子菜单“GhostDoc Pro”。 转到工具 -> GhostDoc Pro -> 选项 -> 规则 您需要编辑您希望其生效的每种类型的 T4 模板。 单击规则,然后点击“编辑” 在顶部修改 /// <summary> ///<# GenerateSummaryText(); #> /// </summary> 公正 /// <summary><# GenerateSummaryText(); #></summary> 在方法GenerateSummaryText中,将每个this.WriteLine修改为this.Write 点击“确定”保存,继续下一个模板。 在关闭选项页面之前,前往“常规”(来自“规则”)并选中“记录此内容时突出显示自动生成的摘要”。 这将导致立即选择新插入的自动文本,因此如果您不喜欢它,您可以开始输入。 当然,如果您希望根本不生成文本,那么您也可以这样做,但您将需要对 T4 模板进行更多修改。 具体来说,您需要 GenerateSummaryText 只需使用一行, this.Write(Context.ExecMacro("$(End)")); 这不会生成任何文本,但会将光标放在 2 个 <summary> 标签之间。 边注: 如果有人知道如何使用 ReSharper 或其他附加工具来执行此操作,我也有兴趣查看该解决方案 - 如果只是出于好奇而没有其他原因。 您可以手动设置注释的格式,只要您喜欢,只要它保持有效的 xml。 最便宜的方法可能是禁用 Visual Studio 中的自动注释构建操作(工具 > 选项 > 文本编辑器 > C# > 为 /// 生成 XML 文档注释)并使用代码片段插入 /// <summary></summary>。 如果您希望默认格式为单行,和/或帮助保持格式整洁和可读,我的插件Atomineer Pro Documentation也可能感兴趣。在众多选项中,有一个选项是对足够短以适合单行的任何注释使用紧凑的 1 行格式。它是专门为此而设计的,因此它可能会更好地满足您的需求。 最后的建议是,还有其他几个插件(Resharper 等)可以生成简单的样板 xml 文档注释 - 我相信其中一些插件可以配置为使用特定的文本片段。如果您已经有这样的插件,则可以调整您的插件以提供您需要的单行格式,其方式比上面建议的基本 Visual Studio 调整稍微更高级。 我今天正尝试这样做。我找不到一种方法来将其更改为自动发生,所以我想我可以随后使用查找、替换和正则表达式来完成此操作。这不是这个问题的一个很好的答案,但它似乎不是一个好的答案,并且所有答案都是解决方法。这是一个很好的解决办法。 与正则表达式对比 找到:(/// <summary>)\r\n\s*///\s*(.*)\r\n\s*///\s*(</summary>)替换:$1$2$3Notepad++ 与正则表达式 找到:(/// <summary>)\r\n\s*///\s*(.*)\r\n\s*///\s*(</summary>)替换:\1\2\3高级 这不仅仅是摘要。 找到:/// <(summary|param|return|remarks)([^>]*)>\s*\r?\n\s*///(\s*(.*))\s*\r?\n\s*/// </(summary|param|return|remarks)> 替换:/// <$1$2>$4</$1>

回答 4 投票 0

如何在 C# XML 文档中引用带有自定义链接文本的参数?

我正在使用 XML 注释记录一些 C# 函数,并且我想使用替代文本而不是参数名称来引用参数。这是我想要实现的目标的一个例子......

回答 1 投票 0

AsciiDoc 中的浮动(带滚动)文本?

AsciiDoc 新手。我想知道是否有一种方法可以让文本“浮动”并滚动(类似于 Excel 中的浮动标题行)。我在分隔线之间输入了一个单词

回答 1 投票 0

是否可以增强 COM 类型库的 Intellisense 以显示成员摘要描述?

我有一个 .NET 8.0、C# 12.0 控制台应用程序项目,其中包含对 Adobe Illustrator 2024 类型库的 COM 引用。成员和参数描述不会显示在 Intellisense 工具提示中...

回答 1 投票 0

为 ValueTuple 中的命名元素添加 XML 文档

使用 C# 7 中的 ValueTuple,现在可以编写返回或使用复合对象的方法和属性,而无需显式声明类型。然而,这些命名元组可能是潜在的

回答 2 投票 0

C# 生成 XML 文档

我创建了一个在 .NET Framework 4.7.2 上运行的新 C# WinForms 项目,我想从 XML 生成的文件创建 pdf 文档。我已成功将 VS docfx.console 包安装为

回答 1 投票 0

XML 文档位于包中,但从未复制到输出目录

生成的包确实包含 DLL 文件旁边的 XML 文件,但是,当使用其他项目的包时,文档永远不会复制到输出目录。 这是重新...

回答 1 投票 0

向 Swagger 添加 XML 文档的最简单方法是什么?

这个问答问题旨在为我自己以及希望为社区提供有用的参考。我将 Swagger 用于所有 Web API,并希望它包含我的源代码文档,如 Swagger...

回答 1 投票 0

在 macOS 上构建 PostgreSQL 文档时出错

我在 macOS 上尝试构建 PostgreSQL 文档时遇到了一个持续存在的问题。错误消息表明 XML 实体、外部实体存在问题。我已经关注了 sta...

回答 1 投票 0

正则表达式替换可变数量的捕获组 |在 Visual Studio 中进行批量 XML 文档编辑

这是一个多合一的问题。 我想将换行符注入到我的 C# 项目的 xml 文档中。 从 /// /// 惰性异步变量读取事件。 /// 包含所有 的变量 这是一个多合一的问题。 我想将换行符注入到我的 C# 项目的 xml 文档中。 出发地 /// <summary> /// Event for lazy async var reading. /// Contains all vars that partecipated to a certain poll, /// indepentently of the fact it succeded or the value changed </summary> 到 /// <summary> /// <br>Event for lazy async var reading. </br> /// <br>Contains all vars that partecipated to a certain poll,</br> /// <br>indepentently of the fact it succeded or the value changed </br></summary> 我的第一个方法是运行正则表达式查找和替换,我成功地根据不同的缩进等正确选择了注释。 当涉及到捕获组时,我没有找到一种方法来引用构成身体的线条。 该行的捕获组和内部捕获组似乎都丢失了。 我的正则表达式: (?x: (?(DEFINE) (?'line'\/\/\/\s*([^\n]+)\n*) ) (?'head'<summary>(?:\s*\n | \s*[^\n]+\n*)) #select summary tag and skip the first line. (?P>line)+ #select each line, capturing both the line and a subset of its content (?'foot'(?:\/\/\/\s*)*<\/summary>) #select summary closure and the empty comment-lines preceding it ) 这个表达式产生 {0}: full match {1 (named head)}: \<summary\>... {4}: last matched (?P>line) {5 (named foot)}: ...\</summary\> 捕获组 {2} 和 {3} 去了哪里? (?'line'..)的内部捕捉团去哪儿了? 是否有 Visual Studio 扩展可以胜任这项任务? 即使正则表达式有效,我也不知道如何引用所有中间组,因为它们的数量是可变的。 我的计划是明确引用所有编号组直到某个编号,并命名其他组以避免选择。有更好的选择吗? 附注如果有一种方法可以发布以颜色编码的漂亮方式格式化的正则表达式“代码”,我没有找到它。欢迎大家指点。 p.p.s。编辑:我显然无法找到相关问题指出“仅通过正则表达式是不可行的,只能通过实际语言中的函数” 这显然可以仅通过正则表达式来完成。 Visual Studio 没有可用的正则表达式引擎。 不过,这可以在 C# 中使用捕获集合来完成。 您也可以硬着头皮使用 Pcre 引擎。 这是给你的一个主意。 (?m)(?:^///\h*<summary>\h*\K(?'line'(?:(?!</?summary\s*>)\S)+(?:\h*(?:(?!</?summary\s*>)\S)+)*)|\G\s*^///\h*\K(?&line)) 替补<br>$0</br> https://regex101.com/r/MX3c66/1

回答 1 投票 0

没有用于 WPF 的 XML 文档/智能感知

我正在使用 Visual Studio 17.5.4 和 .NET SDK 7.0.5 创建新的 WPF 应用程序后,我在 IntelliSense 中没有 WPF 库的可用 XML 文档。 浏览到源 (F12) 显示

回答 0 投票 0

记录 C# 代码时用于警告/重要注释的 XML 标记

是否有任何官方 C# 文档(并由 IntelliSense 识别)识别的任何 xml 标记专门用于作为警告或非常重要的信息注册的内容...

回答 1 投票 0

我如何将C#XML文档格式化为PDF或静态HTML?

存在一个问题:如何设置Visual Studio XML文档的格式以显示在Web上,这与我想要的类似。但是,这个问题的答案都非常古老,工具...

回答 1 投票 0

是否可以在摇摇欲坠的文档中使用XML标记/功能?

例如,我记得阅读过您可以通过编写类似于以下内容的内容来用XML制成表:|| __Column__ || ||行||可悲的是,我不记得了...

回答 1 投票 0

使用Xml文档Member.Name获取方法的MethodInfo的通用方法

我正在尝试使用Xml文档文件条目中的成员名称来获取方法的System.Reflection.MethodInfo元数据。这是基本代码。我已经省略了样板以获得...

回答 1 投票 0

回答 1 投票 0

Delphi单元名称的XMLDoc

是否可以使用 XMLDoc标签在Delphi中记录单位用途?怎么样?我试过把摘要都放在单元前:/// 单元目的:测试 单元测试; ...

回答 1 投票 4

节目 XML标记到Visual Studio智能感知

我添加了 XML标记我的一些方法,但我看不到它在IntelliSense内容。这里是我的代码:/// ///我们都住在黄色总结/// // ...

回答 2 投票 26

© www.soinside.com 2019 - 2024. All rights reserved.