使用了swagger，为了显示注释勾选了输出xml，然后各种“ CS1591 缺少对公共可见类型或成员”警告了

最新推荐文章于 2025-09-11 00:38:31 发布
原创 最新推荐文章于 2025-09-11 00:38:31 发布 · 1.9k 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#.net core #vs2019 #注释警告

使用了swagger，为了显示注释勾选了输出xml，然后各种“ CS1591 缺少对公共可见类型或成员”警告了

有一些是很愿意写注释，也有一些东西并不需要去强调的，但是警告对我来说，太难看了

 

我是.net core 3.0

vs2019

哈哈哈，不能忘记vs2019强大的提示啊

Swagger不显示接口注释
标准都是留给不爱的人，爱的本质是自由意志的沉沦
12-20 3187
1、缺少 XML 注释文件：Swagger 默认使用 XML 注释文件中的注释来生成接口文档。确保在项目的生成设置中启用了 XML 文档生成，并将生成的 XML 注释文件放置在与生成的 DLL 文件相同的目录下。2、修改Program.cs文件，在Build之前增加Swagger的配置项。，路径可以为空指向默认路径。请在右击->属性->生成。
C#WebApi中swagger在线文档输出参数和输入参数显示注释
weixin_30247159的博客
05-21 3489
最近开发webapi 时需要生成在线文档，发现文档里面没注释，在网上查找资料都不齐全，或者看起来很难看懂。 花了点时间搞出来了这个，很多都是借鉴网上资料整理的，通俗易懂小白专用。 最终效果如上图所示 1.定义一个SwaggerControllerDescProvider实现ISwaggerProvider接口 using Swashbuckle.Swagger; us...
C#问题——CS1591 缺少对公共可见类型或成员的 XML 注释
明哲的博客
09-05 5717
CS1591 缺少对公共可见类型或成员的 XML 注释 数据类,生成DLL时,为了阅读方便,在属性中生成了对应注释的XML文件.此时部分未注释的属性提示.内容如图一所示.
缺少对公共可见类型或成员的XML注释
金溪的博客
11-22 8235
方法1：属性->生成选项卡->XML文档文件（勾掉） 不生成XML文档，就不需要检查XML标记了 方法2：为其添加说明 方法3：#pragma warning disable 1591   最后欢迎大家访问我的个人网站： 1024s...
解决ASP.NET Core 10.0 Program类公开导致的CS1591警告：从警告到规范的完美修复
最新发布
gitblog_00120的博客
09-11 312
你是否在升级到ASP.NET Core 10.0后，编译项目时遇到了讨厌的CS1591警告？这个看似简单的警告背后，隐藏着框架设计的重大变更和代码规范的深层要求。本文将带你深入了解这个问题的根源，掌握三种实用的解决方法，并通过官方代码示例学习如何编写符合规范的XML文档注释。 ## 问题根源：从隐藏到公开的Program类 ASP.NET Core 10.0引入了一项重要变更：Program类...
C#------如何处理缺少对公共可见类型或成员的xml注释的警告
weixin_34044273的博客
09-24 2787
出现警告的原因： 使用Swagger框架时   如图，只要加上注释就可以了 使用前： 使用后：  
缺少对公共可见类型或成员“***********”的 XML 注释
AI时代——精细化设计
07-05 1976
 vs里出现大量 视为错误的警告: 缺少对公共可见类型或成员“***********”的 XML 注释      项目右键属性----》生成下 “取消警告(S)”填写“1591”即可
312 Documentation Comments（实现打开Swagger页面，路由后面显示方法的文档注释）
学会分享
06-21 534
Documentation Comments（实现打开Swagger页面，路由后面显示方法的文档注释）
.NetCore中使用Swagger文档自动生成API接口及注释
小目标一个亿
04-15 5552
1、创建一个.NetCore WebApi项目 2、使用Nuget安装Swagger，安装的命令是: Install-Package Swashbuckle.AspNetCore -Pre 3、安装完Swagger插件之后，在Startup.cs文件中的ConfigureServices方法和Configure方法注册并使用Swagger服务。 在Con...
Abp 为Swagger接口页添加详细注释
你要明白，任何问题都不是孤立存在的，一定有人曾经遇到过，并且已经有更好的解决办法了，只是我还不知道。我不应该在黑暗中独自前行，去重新发明轮子，也许我的顿悟，只是别人的基本功！我应该要站在巨人的肩膀上，学习更成熟的经验和方法，然后再来解决这个问题
08-12 2251
从Abp官网创建完项目之后，启动之后，Swagger的接口说明页，默认是没有接口说明的，这样是很不友好的，也不利于接口调用者的使用，所以，我们要实现Swagger页面的接口注释功能。 首先，我们看一下默认启动后，Swagger的接口页面，标红的是我们自己写的获取所有组织机构的接口，默认是没有注释的。 接下来，我们选中我们Application层的项目，右键“属性”，将输出路径选择为“bin\Debug\”，然后再勾选为Xml生成文档，如下图所示。 接下来，在你的 项目名...
Swagger 之注释展示 (.Net Core)
菜鸟厚非
05-26 975
技术栈 介绍 平时安装 swagger ，
Swagger配置及注解.docx
01-10
Swagger配置及注解.docx
.net 程序发布后xml文件找不到的两种解决方法
lgx的专栏
01-06 3315
自己做项目需要用智能客户端发布，我遇到了个问题就是程序中的xml文件在发布后找不到了。经过在网上查询和自己的试验发现这两个方法都可以解决这个问题。 方法1     右键winUI项目，发布-〉应用程序文件....->选择xml文件-〉发布状态改为“数据文件(自动)”        在程序里取xml路径的写法     file = Application.Common
.Net配置Swagger包含中文注释与Header参数传递
世事一场大梦,人生几度秋凉
08-30 8247
使用swagger输出在线api文档非常方便，配置也非常的简单，但是有可能会遇到一些小问题，这里我就把自己遇到的一些小问题记录一下。 1、中文注释 2、如果是分层架构，显示实体类的注释 3、如果接口有token认证，需要在swagger中传递token头部信息 分割 首先在项目中使用nuget工具搜索swagger找到Swashbuckle,选择最新版本安装即可，顺带会自动安装一个Swa...
swagger注释HTML,jax-rs – 使用swagger的注释在Swagger UI中显示XML / JSON样本值
weixin_30213477的博客
06-21 415
我正在实现基于Jersey的REST API并使用swagger生成基于HTML的文档.我正在使用swagger的注释来读取和扫描资源以生成文档.我已使用@ApiResponse注释为每个资源指定了响应,如下所示：@Path("/hello")@Api(value = "Hello World" )public class HelloRest{@GET@ApiOperation(value="He...
【C#】ADO.NET 实体数据模型 warning CS1591:
少莫千华
10-21 1264
问题描述 1>E:\xxx\Models\wx_user.cs(23,30,23,35): warning CS1591: 缺少对公共可见类型或成员“wx_user.state”的 XML 注释 1>E:\xxx\Models\wx_user.cs(24,42,24,53): warning CS1591: 缺少对公共可见类型或成员“wx_user.create_time”的 XML 注释 1>E:\xxx\Models\wx_user.cs(25,23,25,33): warnin.
关于#c##的问题：错误列表出现大量警告
LeifRaphael的博客
05-07 1189
在C#编程中，当编译代码时出现大量警告（warnings）通常意味着代码中存在一些潜在的问题，虽然这些问题可能不会直接阻止程序编译和运行，但它们可能会影响代码的可读性、可维护性或性能。处理这些警告是一个好习惯，因为它可以帮助你写出更健壮、更可靠的代码。最后，建议定期查看并修复警告，以确保代码的质量和可靠性。
谈谈.NET Core中基于Generic Host来实现后台任务
li123128的博客
11-15 1218
　　目录 　　 　　前言 　　 　　什么是Generic Host 　　 　　后台任务示例 　　 　　控制台形式 　　 　　消费MQ消息的后台任务 　　 　　Web形式 　　 　　部署 　　 　　IHostedService和BackgroundService的区别 　　 　　IHostBuilder的扩展写法 　　 　　总结 　　 　　前言 　　 　　很多时候，后台任务对我们来说是一个利器，帮我...
net core8 使用Swagger
07-11
在 .NET Core 8 中集成和使用 Swagger 可以帮助开发者自动生成、测试和浏览 RESTful API 文档。以下是详细的步骤： ### 安装必要的 NuGet 包 首先，确保你的项目中已经安装了用于支持 Swagger 的相关 NuGet 包。通常需要安装以下包： - `Swashbuckle.AspNetCore`：这是核心的 Swashbuckle 包，包含了生成 OpenAPI 文档所需的功能。 - `Swashbuckle.AspNetCore.SwaggerUI`：此包提供了用于浏览和测试 API 的 UI 界面。 你可以通过 Visual Studio 的“管理 NuGet 程序包”功能来搜索并安装这些包，或者使用 .NET CLI 命令如下： ```bash dotnet add package Swashbuckle.AspNetCore dotnet add package Swashbuckle.AspNetCore.SwaggerUI ``` ### 配置 Swagger 服务 在项目的 `Program.cs` 文件中添加对 Swagger 的支持。你需要注册 Swagger 服务，并配置它以扫描你的 API 控制器并生成相应的文档。 ```csharp var builder = WebApplication.CreateBuilder(args); // 添加服务到容器中。 builder.Services.AddControllers(); // 注册Swagger服务 builder.Services.AddSwaggerGen(); var app = builder.Build(); // 配置HTTP请求管道。 if (app.Environment.IsDevelopment()) { // 启用中间件来提供生成的Swagger作为JSON终结点。 app.UseSwagger(); // 启用中间件来提供Swagger UI（HTML, JS, CSS等）。 app.UseSwaggerUI(); } app.UseHttpsRedirection(); app.UseAuthorization(); app.MapControllers(); app.Run(); ``` ### 配置 XML 注释（可选） 为了使 Swagger 能够显示接口方法上的注释，你需要启用 XML 文档文件的生成，并告诉 Swagger 使用该文件中的信息。 1. 在项目属性中，勾选生成 XML 文档文件选项。 2. 在 `Program.cs` 中配置 `AddSwaggerGen` 方法来包含 XML 注释。 ```csharp builder.Services.AddSwaggerGen(options => { var xmlFilename = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml"; options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFilename)); }); ``` ### 访问 Swagger UI 完成以上步骤后，运行应用程序并通过访问 `http://localhost:<port>/swagger` 来查看 Swagger UI 页面。在这里，你将能够看到所有公开的 API 端点，并且可以直接从浏览器进行测试[^5]。 ### 示例控制器注释 为了更好地利用 Swagger 提供的功能，在控制器或动作上添加适当的 XML 注释是非常有帮助的。例如： ```csharp /// <summary> /// 系统模块 /// </summary> [ApiController] [Route("api/[controller]/[action]")] public class SysMenuController : ControllerBase { // ... } ``` 通过上述步骤，你应该能够在 .NET Core 8 应用程序中成功集成和使用 Swagger。接下来是一些可能的相关问题：
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值