Compartilhar via

Regras de documentação

  • Artigo

As regras de documentação dão suporte à gravação de bibliotecas bem documentadas por meio do uso correto de comentários de documentação XML para APIs externamente visíveis.

Nesta seção

Regra Descrição
CA1200: Evitar o uso de marcas cref com um prefixo O atributo cref em uma marca de documentação XML significa "referência de código". Ele especifica que o texto interno da marca é um elemento de código, como um tipo, método ou propriedade. Evite usar marcas cref com prefixos, pois isso impede que o compilador verifique as referências. Isso também impede que o IDE (ambiente de desenvolvimento integrado) do Visual Studio localize e atualize essas referências de símbolo durante refatorações.