Pode classes de implementação “herdar” comentários XML a partir de suas interfaces implementadas?
-
05-09-2019 - |
Pergunta
pergunta curiosa. Estou usando Sandcastle da Microsoft para gerar a documentação dos comentários XML no meu código C #. Várias das minhas aulas estão implementando as interfaces que já comentou métodos. Eu prefiro não duplicar a documentação tanto no método de interface eo método pública implementada. Existe algum tipo de tag que posso usar para "herdar" essa documentação a partir da interface?
Solução
Este recurso não existe atualmente no Visual Studio.
Você pode obter ferramentas de terceiros, tais como GhostDoc que vai ajudar com a criação de documentação XML. GhostDoc também tem a opção de gerar documentação que foi "herdado" como você está tentando fazer.
Link: GhostDoc
Outras dicas
Você pode adicionar <inheritdoc/>
na implementação.
Você deve ter um olhar sobre o seguinte tópico: maneiras de comentários de interface de sincronização e de implementação em C #
Em caso de alguém está à procura de uma solução, eu construí uma biblioteca para pós-processar os arquivos de documentação XML para adicionar suporte para um
Mais informações em www.inheritdoc.io (versão gratuita disponível).