问题标签 [xml-documentation]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
c# - 如果将摘要添加为参考，则摘要不会显示在程序集中
我在 C# 中创建了一个“类库”，它有许多带有摘要的函数（XML 文档注释）。
例如
如果我在同一个命名空间中使用该函数，它会显示摘要，但如果我将它作为参考添加到某个其他工作区（解决方案）中，它不会显示摘要。
如果将其添加为参考，如何使其在其他解决方案中可见，这可能是原因吗？
.net - 按 ctrl+space 时 Visual Studio 显示文档
出于某种原因，我只能看到 .net 库的文档。有没有办法在 Visual Studio 中查看我自己或第三方的文档？
我想知道在 Visual Studio 2010 中按 ctrl+space 时是否可以查看文档。类似于我在 Eclipse 中习惯的 :)。或者至少在方法或类上单击（选择）以能够在某种视图（窗口）中查看文档时？
msdn - 如何从我的 C# XML 文档注释链接到 MSDN/官方文档？
给定一个类的 XML 注释，如下所示：
如何获得对框架文档中相应页面的引用System.Threading.Thread.CurrentPrincipal和链接？System.Web.HttpContext.User
c# - 用于 Xml 文档中 cref 的 Visual Studio Intellisense
当您在 Visual Studio（我使用的是 2010）中为 C# 方法创建 XML 文档时，您会收到 Intellisense 支持以创建各种 XML 标记，例如 see、paramref 等。另一方面，当您添加 aa cref 属性时你必须使用一种我认为是复杂的格式来描述类型。当您有许多泛型时，这是最糟糕的。
我正在寻找的内容如下。如果您在 see 元素中设置 cref 属性，您将拥有一个 Intellisense 类列表，这些列表与您目前输入的内容相匹配，然后输出必要的正确类型描述。或者，当您在 paramref 元素上设置 cref 属性时，您会收到该方法的参数列表。
有谁知道 Visual Studio 的某种插件可以为这些 cref 属性提供智能感知？
c# - C# xml 文档：如何创建注释？
我想在我自己的文档中的此 MSDN 页面的备注部分中实现与黄色“注意：”框类似的事情。
我正在使用 sandcastle 和 sandcastle 帮助文件生成器从文档标签中生成参考网站。我要写什么才能实现这样的笔记框？
c# - 如何在 Sand Castle/MAML 的代码示例中为类名着色
我正在从 nDoc 迁移到 Sand Castle 以生成文档以供我的班级参考。nDoc 不支持 .net 2.0 并且有许多其他限制。
早些时候，使用 nDoc，我能够为我的代码应用漂亮的颜色，包括突出显示类名。
例如Console.WriteLine(something)会Console以不同的颜色显示（因为 nDoc 允许您直接在 XML 中指定 HTML 样式）。
但是，Sand Castle (MAML) 似乎忽略了类型名称（它只接受真正的 C# 代码，不允许用于着色的 HTML 属性，着色由 Sand Castle 本身执行）。最后，只有关键字、注释和常量被着色。这可以修复，以便类型名称也可以着色吗？谢谢！
以下是我使用 nDoc 所拥有的内容以及我需要使用 Sand Castle 复制的内容（MailMessage，Pop3并Console突出显示）。
c# - 在泛型类中注释构造函数的正确方法是什么？
评论这个的正确方法是什么？
VS抱怨它：
警告 11 关于“Data.Repository.Repository(Data.IUnitOfWork)”的 XML 注释具有无法解析的 cref 属性“Repository” C:\Projects\xx\yy\DataAccess\Repository.cs 35 58 数据
c# - 使用 doxygen 为带有 XML 注释的现有 C# 代码创建文档
我到处都读到doxygen 是为 C# 代码生成文档的方法。我有一个我想首先记录的界面（小步骤），并且它已经存在 XML 注释 (///)。
由于大量帖子和可用信息（包括 doxygen.org）说这些评论已经得到支持，我很惊讶当我运行 doxywizard 时，我收到类似“警告：Compound Company::Product::MyInterface is没有记录”。
这使我相信我以某种方式误解了 XML 文档（希望不是，根据MSDN，我说的是正确的事情），或者我错误地配置了 doxywizard。
我首先通过 Wizard 选项卡运行 doxywizard，并指定我要支持 C#/Java。当我运行它时，我的 HTML 页面是空白的，大概是因为前面提到的警告。然后我尝试通过专家选项卡指定一个文件并再次运行——同样的行为。
谁能告诉我我缺少什么开关或设置来让 doxygen 生成 HTML？
这是我的界面中记录的属性/方法的示例：
我确实在界面上方有一条评论，如下所示：
c# - 如何在 C# .NET 文档中添加换行符
这应该更容易...
我想在我的代码中的 XML 文档中添加一个“编码”换行符
如您所见，我找到了一些演示添加 < 和 > 括号的答案。有趣的是，好的 'ol < br/> 换行符不会在 Intellisense 弹出窗口中创建换行符。
我觉得这很烦人...
有什么建议么？