Fehlender XML-Kommentar für öffentlich sichtbaren Typ oder Mitglied

Question

Ich erhalte diese Warnung: "Fehlender XML-Kommentar für öffentlich sichtbaren Typ oder Mitglied".

Wie lässt sich das Problem lösen?

Answer 1

Ich bin spät dran, aber viele Lösungen in diesem Thread konzentrieren sich darauf, die Warnungen im Projekt oder in der Klasse vollständig zu entfernen.

Wenn Sie die legitimen Warnungen beibehalten, aber einige entfernen möchten - z. B. den cancellationToken auf einem WebApi-Controller, wenn Sie die API mit Swagger offenlegen (der API-Benutzer benötigt dies nicht - es wird von DI bereitgestellt).

Hässlich und offensichtlich, aber zumindest in diesem Fall sind die Stempelmarken der letzte Ausweg.

    /// <summary>
    /// Creates a Service
    /// </summary>
    /// <param name="service">The Service Definition</param> (**note no cancellation token param**)
    /// <returns>A newly created item</returns>
    /// <response code="201">Returns the newly created service</response>
    /// <response code="400">If there are validation errors with the submitted json body</response>
    /// <response code="409">Conflict. The service already exists</response>
    /// <response code="500">Because life is never perfect</response>
    [ProducesResponseType(typeof(Service), 201)]
    [ProducesResponseType(400)]
    [ProducesResponseType(409)]
    [ProducesResponseType(500)]
    [HttpPost]
    public async Task<ActionResult> ServiceCreate([FromBody] ServicePostRequest service,
#pragma warning disable 1573  
        CancellationToken cancellationToken = default) //**note: no warning**
#pragma warning restore 1573
    {

Answer 2

Ich erhielt diese Meldung, nachdem ich ein Attribut an eine Methode angehängt hatte

[webMethod]
public void DoSomething()
{
}

Aber der richtige Weg war dieser:

[webMethod()] // Note the Parentheses
public void DoSomething()
{
}