Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Generated XML doc `cref` contains unescaped generic arguments: CS1584 / CS1658 / CS1570 warnings

Aperta
  • Qualcosa non va?
#2,587 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@reginaldalfret ci sta già lavorando.

Dal 9/10/2026.

  • #2592 di @reginaldalfret — aperta

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
68/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
aws, csharp
Ambito
backend

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

bug needs-triage
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

AnnotationsNamespaceClash.zip

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

Lingua principale
C#
Stelle
1.7k
Fork
504
Merge medio
2g 9h
PR unite (30g)
9

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di aws/aws-lambda-dotnet

Tutte le issue di aws/aws-lambda-dotnet

Issue simili

Altre issue su C#

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.