rodrigopg / protheusdoc-vscode

Repositório para implementação dinâmica do ProtheusDoc do TDS para VsCode

ProtheusDoc for VsCode (AdvPL)

Suporte aos recursos e snippets de documentação TOTVS ProtheusDoc para VsCode.

Theme: Atom One Dark

Estou muito feliz pelo seu Download e espero que goste!

---

Descrição

Esta extensão irá detectar a sintaxe de uma função, método ou classe e gerar uma documentação dinâmica no formato ProtheusDoc.

Conheça mais sobre o ProtheusDoc neste post: https://gabrielalencar.dev/2020/01/29/ProtheusDoc-for-VsCode/

Confira este post especial em comemoração a marca de 3k users: AlencarGabriel#48

Issues

Caso encontre algum problema, tenha alguma dúvida ou sugestão de melhoria, fique a vontade para abrir uma Issue ou enviar um Pull Request com sua implementação.

Wiki

Acesse a Wiki para conhecer os recursos, comandos e atalhos da extensão. Lá você encontrará dicas e instruções para configurá-la no seu ambiente, e desfrutar dos recursos da melhor forma.

Features previstas:

• Implementar geração do cabeçalho lendo a declaração da Função;
• Implementar configuração para o nome do Autor Default (caso omitido apresenta o do SO);
• Implementar configuração para ocultar marcadores não obrigatórios;
• Implementar Snippets dos marcadores mais comuns do ProtheusDoc;
• Implementar geração do cabeçalho lendo a declaração do Método;
• Implementar geração do cabeçalho lendo a declaração da Classe;
• Implementar Text Decoration para os atributos do ProtheusDoc ficarem negritos;
• Implementar Hover de Documentação nas chamadas dos identificadores para mostrar o ProtheusDOC;
• Implementar geração de HTML das documentações (Será necessário apoio da comunidade);
• Implementar Diagnóstico da sintaxe e de valores preenchidos dos principais atributos ProtheusDoc;
• Adicionar no IntelliSense todas as palavras/words do editor aberto;
• Implementar função para criar comentários no cabeçalho de todas as funções do fonte;
• Outras solicitações de melhorias pendentes: Veja aqui

---

Comandos & Atalhos da Extensão

A extensão disponibiliza vários comandos, itens de contexto e alguns atalhos para utilização dos recursos implementados.

• Saiba mais na Wiki: Comandos.

---

Hover de documentações

Ao passar o mouse sobre uma função, método ou classe, um hover apresentará os dados das documentações ProtheusDoc presentes na tabela de documentações:

Theme: Atom One Dark

• Saiba mais na Wiki: Hover de documentações.

---

Documentação HTML

Com essa extensão é possível exportar as documentações ProtheusDoc para HTML.

• Saiba mais na Wiki: Documentação HTML

---

Tabela de documentações

A tabela de documentações armazena uma lista de documentações ProtheusDoc detectadas na Workspace ou nos arquivos abertos.

• Saiba mais na Wiki: Tabela de documentações.

---

Configurações da extensão e valores default

A extensão disponibiliza uma série de configurações especiais, inclusive permite alterar os valores default de alguns atributos do ProtheusDoc.

• Saiba mais na Wiki: Configurações.

---

Diagnóstico das documentações ProtheusDoc

As documentações ProtheusDoc devem seguir uma convenção padrão da TOTVS, por isso é disponibilizado um "validador" para diagnisticar as documentações.

• Saiba mais na Wiki: Diagnóstico das documentações.

---

Aproveite, me ajuda e com certeza irá te ajudar também! ❤️

---

Esta extensão foi criada e é mantida pela comunidade. Não tem nenhum vínculo direto ou indireto com a TOTVS®, qualquer uma de suas franquias ou qualquer um de seus representantes. ProtheusDoc é uma convenção criada e mantida pela TOTVS®. Esta extensão tem como objetivo apenas prover recursos que facilitem o uso desta convenção.