IntelliTect / IntelliTect/CodingGuidelines
Where to include message for #pragma disable?
- Linguagem predominante
- C#
- Estrelas
- 12
- Forks
- 16
- Merge médio
- 2min
- PRs com merge (30d)
- 7
Descrição
If I am disabling a warning, what is the format of the justification message.
Here's an idea/approach but it is still ugly, better suggestions welcome:
```
// Justifiction: Properties initialized by Entity Framework.
#nullable disable // CS8618: Non-nullable field is uninitialized. Consider declaring as nullable.
public ApplicationDbContext(
#nullable enable
DbContextOptions? options) : base(options) { }
// Justifiction: Properties initialized by Entity Framework.
#nullable disable // CS8618: Non-nullable field is uninitialized. Consider declaring as nullable.
public ApplicationDbContext(
#nullable enable
```
or, with pragma:
```
// Justification: Uninitialized properties set by Entity Framework.
#pragma warning disable CS8618 // Non-nullable field is uninitialized. Consider declaring as nullable.
public ApplicationDbContext(DbContextOptions options) : base(options) { }
#pragma warning restore CS8618 // Non-nullable field is uninitialized. Consider declaring as nullable.
```
Guia de contribuição
Direção de pesquisa
Revise os dois exemplos de C# na issue e as orientações existentes do repositório sobre convenções de código. Defina um formato acordado para as mensagens de justificativa que acompanham #pragma warning disable, incluindo o posicionamento e a redação, e documente as orientações de forma consistente com o exemplo escolhido.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- csharp
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Status de atividade
- Estagnada
- Clareza
- Precisa de esclarecimento
- Facilidade para iniciantes
- 25/100