Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở
  • Có gì không ổn?
#2,587 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@reginaldalfret đang làm issue này rồi.

Từ ngày 9/10/2026.

  • #2592 của @reginaldalfret — đang mở

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
68/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
aws, csharp
Lĩnh vực
backend

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
C#
Star
1.7k
Fork
505
Merge trung bình
1 ngày 6 giờ
Pull request đã merge (30 ngày)
10

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của aws/aws-lambda-dotnet

Tất cả issue của aws/aws-lambda-dotnet

Issue tương tự

Thêm issue về C#

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.