Generated XML doc `cref` contains unescaped generic arguments: CS1584 / CS1658 / CS1570 warnings
维护者通常 1 天内回复
评估
调研方向
Start in the Lambda Annotations source that generates handler XML documentation; the issue does not name a file or test, so first locate the generated cref and its tests. Reproduce with a generic handler and GenerateDocumentationFile enabled. Done when the generated XML uses valid generic-argument syntax or omits the cref, and the build produces no XML documentation warnings.
由索引模型根据 Issue 内容生成。
描述
Describe the bug
When a [LambdaFunction] method has a generic parameter type the
generated handler's XML doc comment contains a cref with < and > written literally. This is invalid XML doc
syntax and produces warnings on every build with GenerateDocumentationFile enabled. It does not depend on any
namespace clash.
Regression Issue
- Select this option if this issue appears to be a regression.
Expected Behavior
Generic arguments in a cref are written with braces, e.g.
SqsBatchProcessor{MyPayload, MyHandler}, or the cref is omitted from the generated comment. The generated file
then produces no warnings.
Current Behavior
Incorrect references are generated
/// The generated Lambda function handler for <see cref="Handle(Amazon.Lambda.SQSEvents.SQSEvent, Amazon.Lambda.Core.ILambdaContext, Common.Lambda.Queue.SqsBatchProcessor<Acme.EventDistributor.Trigger.Models.EventBridge.EventBridgePutObject, Acme.EventDistributor.Trigger.EventDistributorTrigger>)"/>
Reproduction Steps
Any handler with a generic parameter, built with <GenerateDocumentationFile>true</GenerateDocumentationFile>:
[LambdaFunction]
public Task<SQSBatchResponse> Handle(SQSEvent evt, ILambdaContext ctx,
[FromServices] SqsBatchProcessor<MyPayload, MyHandler> processor) => ...
Possible Solution
Generic arguments in a cref are written with braces, e.g. SqsBatchProcessor{MyPayload, MyHandler}
Additional Information/Context
Sample solution
AWS .NET SDK and/or Package version used
Amazon.Lambda.Annotations 2.4.1
Targeted .NET Platform
.NET SDK 10.0.401
Operating System and version
Windows 11
- 主要语言
- C#
- 星标
- 1.7k
- 派生
- 504
- 平均合并
- 2 天 9 小时
- 30 天内合并 PR
- 9
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
aws/aws-lambda-dotnet 的其他 Issue
-
bug module/aspnetcore-support p2 queued
难度 2/5 1-3 小时 新手友好度 68/100
aws/aws-lambda-dotnet#1123 · 4 条评论 · 1 个 reaction ·
维护者通常 1 天内回复
-
feature-request needs-triage
难度 3/5 1-2 天 新手友好度 55/100
aws/aws-lambda-dotnet#2588 ·
维护者通常 1 天内回复
-
bug needs-triage
难度 3/5 1-2 天 新手友好度 67/100
aws/aws-lambda-dotnet#2586 ·
维护者通常 1 天内回复
-
feature-request p2
难度 4/5 3-5 天 新手友好度 48/100
aws/aws-lambda-dotnet#2551 · 1 条评论 ·
维护者通常 1 天内回复
-
JSON log format pairs ILogger message template placeholders with state values by position, garbling ASP.NET Core hosting logs可能已有人在做 @Pybsama 于 73 天前认领。 未关闭bug investigating p2
难度 3/5 1-2 天 新手友好度 70/100
aws/aws-lambda-dotnet#2468 · 2 条评论 ·
维护者通常 1 天内回复
查看 aws/aws-lambda-dotnet 的全部 Issue
相似的 Issue
-
Bug: Hidden loading rings keep the compositor running, so Files uses 7-94% of a CPU core while idle未关闭
难度 2/5 1-3 小时 新手友好度 72/100
files-community/Files#19026 · 1 条评论 ·
维护者通常 1 天内回复
-
Physgun SFX Spam未关闭
难度 2/5 1-3 小时 新手友好度 62/100
-
难度 1/5 1 小时以内 新手友好度 80/100
SubtitleEdit/subtitleedit#15946 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
BHoM/Civil3D_Toolkit#118 ·
-
Reason-phrase table has misspelled entries (`Unathorized`, `Switching Protcols`, `Multiple Choises`)未关闭bug severity:low
难度 2/5 1-3 小时 新手友好度 65/100