c# - 如何向 C# 9 记录添加注释

Question

C# 9 记录有一个简短的形式，如下所示:

public record Car(int CarId, int Cylinders, string Make, string Model);

如何将文档注释添加到记录的属性中？请注意，这与 this 不同关于长格式的其他问题。

Answer 1

正确的方法看起来就像这样简单:

/// <summary>
/// Represents a car.
/// </summary>
/// <param name="CarId">The id of the car.</param>
/// <param name="Cylinders">The number of cylinders.</param>
/// <param name="Make">The make of the car.</param>
/// <param name="Model">The model of the car.</param>
public record Car(int CarId, int Cylinders, string Make, string Model);

当您创建此记录的新实例(即 new Car(...) 将为您提供不同参数的信息)时，这在 IDE 的 IntelliSense(VSCode 上的测试)中确实有效。
但是，如果您有 <GenerateDocumentationFile>true</GenerateDocumentationFile>，则编译器的警告系统本身似乎存在问题。在您的 .csproj 中启用.对于每个参数，您将获得以下警告对:

warning CS1572: XML comment has a param tag for 'CarId', but there is no parameter by that name
warning CS1573: Parameter 'CarId' has no matching param tag in the XML comment for 'Car.Car(int, int, string, string)' (but other parameters do)

所以它确实有效，但是编译器提示参数没有被记录，并且有一个不存在的参数的文档。
Put record parameters in scope of xml docs #49134可能会在下一个版本中解决这个问题，希望如此。