github/csharp-docs

O que csharp-docs faz?

Garante que tipos C# sejam documentados com comentários XML e sigam as melhores práticas de documentação.

Descrição

Esta habilidade analisa seu código C# e verifica se todos os tipos e membros públicos e protegidos possuem comentários XML adequados. Ela também valida se a documentação segue as melhores práticas, como descrições claras e uso correto das tags XML.

Funcionalidades

• Verifica a presença de comentários XML em tipos públicos e protegidos.
• Valida a qualidade da documentação, como descrições significativas e tags corretas.
• Recomenda a inclusão de tags summary, param, returns, exception e remarks quando apropriado.
• Integra-se ao processo de compilação para garantir que a documentação esteja sempre atualizada.

Como usar

1. Instale a habilidade no seu projeto C# via NuGet ou como uma ferramenta global.
2. Execute a análise no seu código:

dotnet csharp-docs check

3. Corrija os problemas relatados.

Requisitos

• .NET SDK 6.0 ou superior.
• Projeto C# com configuração de documentação XML habilitada.

Exemplo

Arquivo Program.cs:

/// <summary>
/// Ponto de entrada do aplicativo.
/// </summary>
public class Program
{
    /// <summary>
    /// Método principal que inicia a execução.
    /// </summary>
    /// <param name="args">Argumentos da linha de comando.</param>
    public static void Main(string[] args)
    {
        // Código aqui
    }
}

Suporte

Para relatar problemas ou sugerir melhorias, visite o repositório github/csharp-docs.