Regras de documentação
As regras de documentação suportam a escrita de bibliotecas bem documentadas através da utilização correta de comentários de documentação XML para APIs externamente visíveis.
Nesta secção
Regra | Description |
---|---|
CA1200: Evite utilizar etiquetas cref com um prefixo | O atributo cref numa etiqueta de documentação XML significa "referência de código". Especifica que o texto interno da etiqueta é um elemento de código, como um tipo, método ou propriedade. Evite utilizar cref etiquetas com prefixos, uma vez que impede o compilador de verificar as referências. Também impede que o ambiente de desenvolvimento integrado (IDE) do Visual Studio encontre e atualize estas referências de símbolos durante as refatorizações. |
Colabore connosco no GitHub
A origem deste conteúdo pode ser encontrada no GitHub, onde também pode criar e rever problemas e pedidos Pull. Para mais informações, consulte o nosso guia do contribuidor.