1
resposta

Documentar classes do projeto WebApi.Model

A documentação para as classes do projeto Alura.WebAPI.Model não funcionou. Somente as classes do projeto Api gerou documentação. Existe algo que possa ser feito para que as classes Models tb sejam documentadas? Classe e propriedades por exemplo.

1 resposta

Olá Carlos, como vai?

Sinto muito pela demora em te retornar.

O projeto Alura.WebAPI.Modelseria algo interno de nossa API, não seria bacana poder documentar no estilo que documentamos uma API.

Perceba que não temos nenhuma IActionResult nesse projeto, não vamos "subir" de nenhuma forma. Isso já nos faz refletir se teriamos a necessidade de detalhar da mesma forma que fizemos como nosso projeto Alura.WebAPI.Api, que é o projeto onde realmente colocaremos à disposição do cliente final.

Notei que já concluiu o curso C# parte 5: Bibliotecas DLLs, documentação e usando o NuGet. Para documentação interna, o que aprendeu neste curso, cairia bem.

Espero ter ajudado de alguma forma. Abraços!

Quer mergulhar em tecnologia e aprendizagem?

Receba a newsletter que o nosso CEO escreve pessoalmente, com insights do mercado de trabalho, ciência e desenvolvimento de software