Documentação em comentários

Owned by Leandro Miozzo Bonato
Aug 15, 2024
1 min read

Em muitos desenvolvimentos são criados comentários para documentar o que foi desenvolvido e/ou quais desenvolvedores contribuíram para determinado código, ou ainda para informar aos desenvolvedores que irão ver este código no futuro, quais tarefas trabalhadas.

Pensando nisto, foi criado um modelo para padronizar e contribuir com este tipo de informação nos scripts sem que polua muito o código do desenvolvedor.

  1. Para usá-lo pressione o atalho CTRL + J

  2. Procure por ModeloDocumentacao

  3. Pressione ENTER e o seguinte bloco de código aparecerá.

{ Tarefa: $ID_TAREFA Chamado: $ID_CHAMADO Título tarefa: $TITULO_TAREFA Autor: $DESENVOLVEDOR Data: $DATA_DESENVOLVIMENTO Requisitos: $CRITERIOS_REQUISITADOS }