Olá Dev, neste artigo vou apresentar a extensão Protheus Doc for VsCode. Meu mais recente projeto de contribuição para comunidade TOTVS/Protheus.  

Espero que goste e lhe ajude!  

O que é o ProtheusDoc?  

Para quem não conhece, ou sabe do que este artigo se trata, segue uma definição retirada do próprio TDN (Totvs Developer Network):

“O ProtheusDOC, é uma forma estruturada de escrever comentários, sobre funções, classes, métodos ou qualquer outro elemento de um programa-fonte AdvPL, que descreve a utilização deste elemento.” https://tdn.totvs.com/display/tec/ProtheusDOC

Talvez você utilize até hoje (ou não usa nada) o layout de documentação no formato Ms Linedraw. Realmente este por muito tempo foi a forma “padrão” de documentar funções, métodos, etc. Obs.: lembrando que estou falando de linguagens da TOTVS neste artigo.

Quais as vantagens do ProtheusDoc?

Na minha opinião, além do aspecto visual do código mais clean, existe tambem a questão da padronização e estruturação de algo que é próprio da linguagem, parecido com a implementação de outras (por exemplo o JavaDoc).

Dá para perceber de cara a diferença entre os formatos!

Extensão ProtheusDoc for VsCode (AdvPL):

Com o intuito de fornecer ao VsCode a maior quantidade de funcionalidades possíveis do ProtheusDoc já implementado no TDS Eclipse de forma nativa, criei esta extensão para dar suporte aos recursos padrões do ProtheusDoc conforme documentação da TOTVS, além de dinamizar a criação da documentação reconhecendo a sintaxe da função, método ou classe a ser documentada.

Bem, existem bastantes funcionalidades a serem implementadas, e caso tenha desejo de contribuir me envie um Pull Request ou abra uma Issue reportando o problema.

Recomendo que ao instalar a extensão, dê uma olhada na documentação da mesma, para conhecer todas as funcionalidades já implementadas e as futuras, e como configurar/utilizar esses recursos.

Para baixar a extensão acesse: https://marketplace.visualstudio.com/items?itemName=AlencarGabriel.protheusdoc-vscode

Veja mais em https://github.com/AlencarGabriel/ProtheusDoc-VsCode

Espero ter ajudado, em breve mais artigos apresentando outros projetos. Até a próxima!