xml-documentation相关内容

Swashbuckle + XmlComments 在本地工作,但在服务器上生成招摇失败

我有一个 webapi 项目,我正在使用 swashbuckle 框架来清除 api 文档. 我已按照说明使用我的控制器和 DTO 构建文档 xml 文件,并且在本地运行良好. 但是,在生成 swagger 文档时,会抛出 500 错误.我已经确认如果我删除我的 xml 注册行,就会生成并成功返回 swagger 文档. 这是我的注册行: GlobalConfiguration ..

NuGet 包未将 XMLDoc 文件与 dll 一起复制到 bin

我正在使用 NuGet GUI 并尝试将 XML 文件与我的 DLL 一起包含以与 DLL 一起分发帮助. 当我在任何项目中安装包时,它成功添加了 DLL 引用,但在添加包的项目的 bin 文件夹中没有生成 XML 文件. XML 文件在 packages\\lib\.XML 中可用 非常感谢任何帮助. 提前致谢 解决方案 站在你这边: 查看这篇文章: ..
发布时间:2022-01-20 09:21:49 其他开发

命名空间的 XML 文档

你会为命名空间编写 xml-doc 吗?如果是,如何以及在哪里? 我想,如果可能的话,可能是这样一个几乎是空的文件: //////这个命名空间包含东西///命名空间 Some.Namespace{} 但这会起作用吗?既然你......“声明",或者至少在所有其他文件中也使用命名空间......如果你在同一个命名空间的其他地方写了一个 xml 文档会发生什么?一个会消失吗 ..
发布时间:2022-01-14 23:32:36 C#/.NET

记录 F# 代码

在具有单个构造函数的 C# 类中,我可以添加类摘要 XML 文档和构造函数 XML 文档: ///////这个类会解决你所有的问题///公开课很棒{//////初始化 的新实例班级.//////秘制酱料.公共很棒(串酱){//...出于安全目的省略了实现}} 如何对等效的 F# 类执行 ..
发布时间:2022-01-05 10:15:21 其他开发

Web Api 的 Xml 文档如何包含主项目之外的文档?

文档 用于启用 XmlDoc您的 Web Api 项目似乎只处理所有 API 类型都是 WebApi 项目的一部分的情况.特别是,它讨论了如何将 XML 文档重新路由到 App_Data/XmlDocument.xml 并取消注释配置中将使用该文件的行.这隐含地只允许一个项目的文档文件. 但是,在我的设置中,我在一个常见的“模型"项目中定义了我的请求和响应类型.这意味着,如果我定义了一个端点 ..
发布时间:2021-12-20 12:55:23 C#/.NET

神秘的“用法"Visual Studio 文档 XML 注释标签中的标签

我经常使用 XML 文档来记录我的类、方法和属性,但请查看 Microsoft 的此方法: 用法?这是什么魔法?如何模仿这种魔法? 源代码中没有这样的东西,我检查了(.Net 4.5).它也没有 xmldoc 标记,它不应该存在,但它显示在工具提示中. 我不久前注意到了它,但没有时间进行调查,所以现在我有,而且我浪费了至少一个小时试图徒劳地弄清楚. 这是一件好事,因为它显示 ..

从 XML 文档中隐藏类/方法

我需要使用 XML-Doc 和 Sandcastle 记录程序集中的许多接口.但是,在构建文档文件时,我还想忽略一些接口.现在我设法通过使用标记为 internal 的那些接口编译程序集来做到这一点,但这更像是一种解决方法而不是问题的解决方案,因为实际上,那些需要 public.是否有某种属性可以装饰不需要的属性,以便它们被忽略? 解决方案 我认为从 IntelliSense 中隐藏特定类 ..
发布时间:2021-09-18 20:30:12 C#/.NET

如何在 Visual Studio 2008 中为 asp.net 网站生成 xml 文档?

我正在尝试为我的 asp.net 网站页面生成 XML 注释.但是当我在解决方案资源管理器中右键单击网站时,我找不到 Properties 而是找到 Proper Pages.如何开始使用 xml 文档?任何建议. 更具体地说:http://msdn.microsoft.com/en-我们/图书馆/azt1z1eh.aspx(“在 Visual Studio 中构建 XML 文档示例"部分) ..
发布时间:2021-09-18 20:24:27 其他开发

将常量渲染到 XML 文档中?

我有 2 个私有常量和一个公共方法: private const byte _minAge = 24;私有常量字节_maxAge = 29;public bool IsInAgeRange() { ... } 我正在添加 XML 文档,并且希望我的代码用户可以在 IntelliSense 中阅读此内容:检查年龄是否在允许的范围内(介于 24 和 29 之间). 我的问题是:有没有办法将我 ..
发布时间:2021-09-18 19:33:41 C#/.NET

Swashbuckle + XmlComments在本地工作,但无法在服务器上生成摇摇欲坠

我有一个webapi项目,并且我正在使用swashbuckle框架来刷新api文档. 我已经按照说明使用控制器和DTO来构建文档xml文件,并且在本地都可以很好地工作. 但是,生成摇摇欲坠的文档时,会引发500错误.我已经确认是否删除了xml注册行,生成了大张旗鼓的文档,并成功返回了. 这是我的注册热线: GlobalConfiguration.Configuration.E ..

记录F#代码

在具有单个构造函数的C#类中,我可以添加类摘要XML文档和构造函数XML文档: /// ///This class will solve all your problems /// public class Awesome { /// /// Initializes a new instance of the ..
发布时间:2020-11-02 23:49:41 其他开发

Visual Studio:警告缺少专用和内部成员的XML文档

我正在使用Visual Studio 2005(VS.8.0),并且希望强制要求记录所有类成员(而不仅仅是公共成员)。在不记录公共成员,受保护成员或内部受保护成员的情况下,设置Visual Studio生成警告很简单,但我正在寻找一种使私有成员和内部成员抛出相同警告的方法。有建议吗? 注意:我正在使用警告级别4,将警告视为错误,并且设置了Generate XML标志。 解决方案 不幸 ..
发布时间:2020-10-06 23:54:31 其他开发

我可以将XML文档从接口传播到其实现吗?

我需要将XML文档从基类传播到派生类,或者从接口传播到实现. 我可以使用Resharper做到这一点吗? 解决方案 是的. 如果您尚未实现/覆盖成员,则在派生类或接口实现中,单击 Alt + Ins ,选择“覆盖成员"或“实现"失踪的成员".在随后显示的向导中,选择要实现/覆盖的成员,并确保选择“复制XML文档". 或者,如果您已经有一个覆盖或实现的成员,请在覆盖/实现的 ..
发布时间:2020-07-26 22:44:45 其他开发