Skip to content

Documentação.Exemplos

Jump to bottom
wilsade edited this page Jul 6, 2018 · 10 revisions

Summary default

Ao documentar, ao invés de gerar o esqueleto do summary em branco, o nome do Tipo/Membro será preenchido.

Procurar documentação no mesmo aquivo

Ao documentar qualquer Tipo ou Membro, busca por summary no mesmo arquivo por Tipo/Membro que tenha o mesmo nome do elemento que está sendo documentado.

Procurar documentação em classes Bases / Interfaces

Considere a classe Conta definida no arquivo Conta.cs

Geração de documentação da classe filha ContaCorrente definida no arquivo ContaCorrente.cs

Atualização de summary

Ao documentar um Tipo/Membro que já possui summary:

  • Mantém o summary já definido;
  • Remove parâmetros inexistentes;
  • Insere os novos parâmetros;

Dicionário

Separação de palavras

Cada palavra presente na string será separada, conforme inicial maiúscula.

Definição de abreviações

Qualquem membro que começa com "Is"

O summary será preenchido buscando informações do membro e do tipo.

Métodos construtores

Métodos com começam com "Get"

Retornam alguma classe de "log"

Prioridade das regras

Considere a seguinte regra já criada:

  • Válida para qualquer membro;
  • Começando com "Is"
  • Definção do summary personalizado;

Note que o summary é gerado conforme o esperado:

Ao criar uma regra com maior prioridade:

A geração do summary pode acontecer de maneira inesperada:

Clone this wiki locally