Identificado que o atributo @version quando gerado automaticamente pelos comandos, não está sugerindo as versões do Protheus como acontece no Snippet @version.

Identificado que ao abrir arquivos grandes, a extensão está processando todas as funções do evento onDidChangeActiveTextEditor porém mesmo que não seja em um arquivo AdvPL suportado (exemplo arquivo pós gerado fontes do RPO).

exthost-d93e8e.txt (renomear para .cpuprofile)

Será necessário tratar nas funções/métodos para que estes não executem caso não seja um arquivo AdvPL válido.

Identificado um problema no diagnóstico das documentações, pois quando há caracteres de * na descrição, o validador não interpreta o bloco de documentação todo.

Ex.:

/*/{Protheus.doc} TVPE002
Função para abrir arquivos *.SQL.
@type class
@author Gabriel Alencar
@since 13/12/2020
/*/

Boa tarde.

Há alguma possibilidade de restrição de geração da documento, por algum atributo ?
Exemplo: Não gerar ProtheusDoc para 'types' do tipo 'method'.

Att.

Tratar na tabela de tipos do AdvPL para considerar também os tipos Char e Block.

Olá, primeiramente parabéns pela extensão. Tem sido muito útil para documentação dos meus projetos demonstrando um algo nível de profissionalidade ao apresentar o HTML com a documentação dos programas.

Utilizo muito a opção de gerar a documentação por pastas, assim consigo englobar todo o projeto. Tentei encontrar nas configurações ou nas issues como ignorar uma pasta especifica semelhante ao .gitignore, porém não consegui identificar. Existe essa funcionalidade implementada?

Caso não exista, seria possível a implementação? Não conheço muito TypeScript mas se for o caso posso tentar submeter uma alteração para análise, cheguei a imaginar uma possível validação do repositório no arquivo extension.ts dentro de addGenerateHTMLFolder.

Para melhorar o entendimento, estou anexando uma imagem de um repositório de um cliente meu, onde tenho dentro do diretório /temp/ os arquivos de consulta ou testes que não são interessantes manter no repositório.

Grato pela extensão.

Seria possível que essa engine do ProtheusDoc considerasse os parâmetros entre colchetes como parâmetros opcionais?

(https://tdn.totvs.com/display/tec/ProtheusDOC)

Exemplo:
@param nBase, numérico, Medida do lado ou da base
@param [nAltura], numérico, Medida da altura
@param [nBaseMenor], numérico, Medida da base menor (trapézios)

Os 2 últimos parâmetros são opcionais.

Hoje o diagnóstico está considerando como um erro no ProtheusDoc.
Seria muito interessante que isso fosse considerado tanto no diagnóstico, como na geração HTML (Informando o termo "Opcional" ao lado do parâmetro).

Isso evita termos que descrever na descrição do parâmetro se ele é opcional ou obrigatório.

Ao passar o mouse, exibir o valor e onde está definido o valor de uma constante definida no próprio fonte.

Seria interessante também a possibilidade de ter a funcionalidade para defines que estejam dentro dos includes.

Identificado que classes que herdam outras não estão sendo detectadas pelo ProtheusDoc.

Verificar a expressão que detecta uma estrutura de classe e ajustar para entender a sintaxe com herança.

• Interpretar no Hover de identificadores as propriedades History;
• Criar configuração para que o usuário defina se deseja ou não apresentar o History no Hover.

Caso não tenha sido definido, assumir @type function, por ser a maioria nos fontes.
Com isso diminui significantemente a quantidade de warnings emitidos.

Hi, I maintain VS Code's Webview API

Issue

Our telemetry suggests that your extension uses webviews and may be loading resources in these webviews using hardcoded vscode-resource: URIs. These URIs have some important limitations and don't work properly when VS Code is run in a browser. We are also making changes in the desktop version of VS Code that may cause these URIs to not work properly in future versions of VS Code.

While we are making our best effort to continue support existing webview extensions that use vscode-resource: URIs on desktop versions of VS Code, we will not able to fully support all uses cases.

Fix

To ensure that your extension continues to work in as many environments as possible—including on web and remotely—please:

• Switch to use the Webview.asWebviewUri function for loading resources.

• Switch to use the Webview.cspSource property in content security policies.

These APIs shipped around 2 years ago so they should be available in all modern versions of VS Code. You can find additional information about the issue here: microsoft/vscode#97962

Let me know if you have any questions about this change

Muitas vezes quando estamos fazendo a documentação apertamos o atalho de geração de documentação e esquecemos de preencher o conteúdo.

Marcar como warning propriedades de descrição que estejam com o valor gerado automático.

Tornar o Snippet @history dinâmico, para que ao ser chamado adicione o nome do usuário conectado ou a configuração autor_default.

Utilizar mesmo comportamento do Autor do Bloco ProtheusDoc.

Adicionar suporte ao atributo @link

Sintaxe: @link link-text

Criar opção para gerar a documentação de arquivos específicos, facilitando nas exportações de workspaces maiores.

Sugestão do @PAULOCAMATA

Ao fazer o hover de uma função estática, deveria ser apresentada somente a documentação da função daquele fonte.

Isso fica claro com a função ModelDef, por exemplo.

Abraço

• Issue Type: Performance
• Extension Name: protheusdoc-vscode
• Extension Version: 0.6.1
• OS Version: Windows_NT x64 10.0.18362
• VSCode version: 1.52.0

⚠️ Make sure to attach this file from your home-directory:
⚠️c:\Users\SANDRO~1.COS\AppData\Local\Temp\AlencarGabriel.protheusdoc-vscode-unresponsive.cpuprofile.txt

Find more details here: https://github.com/microsoft/vscode/wiki/Explain-extension-causes-high-cpu-load

AlencarGabriel.protheusdoc-vscode-unresponsive.cpuprofile.txt

Adicionar na configuração uma opção para trazer uma versão inicial padrão ao inserir uma nova documentação.
Exemplo: @Version 1.0

Está apresentando os erros
Dentro do arquivo .PRW ao chamar o Protheus >> Adicionar bloco de Documentação

Command 'ProtheusDoc - Adicionar bloco de Documentação' resulted in an error (command 'protheusdoc.addDocBlock' not found)

Command 'ProtheusDoc - Atualizar tabela de documentações' resulted in an error (command 'protheusdoc.updateTableDoc' not found)

Gabriel,
Boa Tarde!
Ao gerar as documentações em HTML foi percebido que o Gerador do ProtheusDoc não está considerando várias tags @see.
Ele está considerando apenas a última tag colocada.

Exemplo:

@see Vide Função u_FATH9Manutencao()
@see Vide Função u_FATH9ItensCons()

Na documentação do ProtheusDoc ele cita que aceita múltiplos "@see".
https://tdn.totvs.com/display/tec/ProtheusDOC

Uma opção nas configurações para informar tags específicas.

Identificado após alguns testes que extensões tratadas com Glob patterns na configuração "protheusDoc.include" não estão considerando arquivos com extensão maiúscula.

Como a tabela de documentações usa este padrão global para buscar os arquivos na workspace, arquivos com extensão maiúscula estão sendo ignorados.

Problema reportado na microsoft/vscode#10633, e aguardando correção.

Identificado que a numeração da linha que é exibida na localização do Documentation Hover, não representa a linha correta no arquivo (-1).

O link funciona e posiciona corretamente.

Informa que é linha 2:

Mas é linha 3:

Identificado que o Snippet do @return está tabulando no return_type sem necessidade quando a função tem tipagem de retorno definida.

Bom dia!

Ao documentar uma função que tenha os parâmetros e/ou retorno tipado, deveria assumir os definidos e não tentar adivinhar.

Resultado:

Esperado:

Ajustar expressão que identifica a sintaxe da assinatura, para que permita espaços entre as palavras.

Bom dia, tudo bem?

Dependendo da indentação do bloco do ProtheusDoc, as snippets não são reconhecidas corretamente, por exemplo:

Fonte:

HTML Gerado:

Atenciosamente,

Ao gerar a documentação ProtheusDoc acima da função as snippets @type, @author, @SInCE, @Version quando possuem espaçamento para alinhamento/formatação ao gerar Documentação HTML seus conteúdos não são considerados e devidamente formatados.

Para correta geração e formatação da Documentação HTML as chaves devem permanecer no início da linha, sem espaço a esquerda.

//{Protheus.doc} MyFunc
{{TAB}}Função estática geral.
{{TAB}}@type function
{{TAB}}@author denis.galvani
{{TAB}}@SInCE 05/04/2019
{{TAB}}@Version 2.0
{{TAB}}@param aMvPar , array , Parâmetros de pesquisa via Pergunte
{{TAB}}@param lJob , logical , Execução via JOB ou rotina de reprocessamento (por usuário)
{{TAB}}@return array , Valores de parâmetros de Pergunta de acordo com tipo de execução (JOB ou usuário)
{{TAB}}@see - Parâmetros (SC6): MV_STALM, MV_TPLIM, MV_DIATR;
{{TAB}}{{TAB}} - Pergunte (SX1) - "LIBCRDT"
{{TAB}}@history denis.galvani, 22/08/2020, denis.galvani, Inclusão/padronização de documentação de cabeçalho
{{TAB}}//
Static Function MyFunc(aMvPar,lJob)

Identificado que a decoração das propriedades @param, etc... Estão sendo aplicadas em todos os tipos de arquivo.

Ajustar para que sejam apresentadas somente em linguagens suportadas pelo ProtheusDoc.

Após algumas análises, testes e reports dos usuários, foi identificado que o completion provider, implementado na extensão para apresentar o snippet para criação da documentação ProtheusDoc, está fazendo com que o VsCode pare de sugerir na primeira inspeção do IntelliSense as palavras, apresentando na maioria das vezes somente os snippets.

Check-list dos ajustes:

• Retirar provedor do Snippet Add ProtheusDoc Block; (7fc214f)
• Refazer GIF de apresentação da extensão;
• Ajustar Wiki de Comandos para remover a documentação com Snippet;
• Ajustar What's new/Change log informando (a nova melhoria implementada)

O problema (original da não apresentação das palavras quando há provedor de completion) já foi identificado pela Microsoft na microsoft/vscode#21611, porém ainda não resolvido.

Primeiramente muito obrigado Gabriel essa extensão é show mesmo! O quão difícil seria ter mais uma sessão com os parâmetros de sistema (SX6) encapsulados dentro de cada função avaliada? :)

Conforme sugestão do Rodrigo Gonçalves nas reviews, adicionar a possibilidade de editar o template HTML.

Avaliar se não seria interessante tratar na #38

Identificado que nos casos onde a assinatura da função tem ( ) mas não tem definição de parâmetros, a extensão está adicionando uma seção de parâmetros vazia.

• Tratar para trazer o bloco de parâmetros apenas quando houver definição.

Identificado após alguns testes que o link do hover para documentação dos identificadores de métodos está sempre referenciando a linha 1 do arquivo.

Identificado após a ultima atualização que o Hover de documentações está trazendo apenas a documentação do fonte aberto.

Implementar na extensão o pacote NPM vscode-ext-codicons para trabalhar com os ícones padrões do VsCode de forma mais estruturada.

Identificado que o auto complete da extensão para adicionar o ProtheusDoc está retirando o comportamento do InteliSense do VsCode de sugerir as strings.

Identificado que quando há os caracteres: * ou : na descrição do atributo @history o texto está sendo quebrado.

Obs.: Na DOC HTML não acontece.

Identificado que em determinados momentos, ao chamar o IntelliSense o VsCode travava e causava auto consumo de CPU.

Após vários testes, foi identificado que havia uma falha na expressão regular que detecta as assinaturas AdvPL suportadas, sempre que a linha posicionada era a declaração de um método WS REST com WSSYNTAX contendo "/", exemplo:

WSMETHOD GET DESCRIPTION "Saldo B2 do Produto" WSSYNTAX "asdfa/sdas/adfa"

CPU-20210226T210330.838Z.cpuprofile (remover .txt para utilizar)

Bom dia.

Ao inserir um webservice (Rest / Soap), o protheusDoc não gera o cabeçalho.
Isso é uma limitação do ProtheusDoc mesmo ou do plugin?

Att.

Identificado nos testes que ao utilizar o Snippet fora do trecho apropriado para criação do bloco ProtheusDoc, o conteúdo da linha está sumindo.

Ajustar para que o Snippet manipule apenas a área digitada do prefixo.

Segue imagem das advertências. O que fazer ??

Diminuir compatibilidade mínima do VsCode para extensão.

Identificado que parâmetros de função que continham a palavra As estão sendo cortados.

Exemplo: cFase

/*/{Protheus.doc} COMP022_MVC
description
@type function
@version
@author Gabriel Alencar
@since 27/04/2020
@param cF, character, param_description
@param cPara, character, param_description
@return return_type, return_description
/*/
User Function COMP022_MVC(cFase, cPara)

Ao acessar o arquivo pelo link do Location do Hover, ir diretamente para a linha da documentação relacionada.

Ao utilizar vírgula (,) na descrição das propriedades @param e @return o conteúdo após a vírgula não é incluído na documentação.

Exemplo:

@param cParam1, character, Descrição do parâmetro, ref. ao campo "ABC_XYZ"
@return NULL, Nenhum, vazio

• "Descrição" com vírgula não são totalmente incluídas na documentação HTML;
• Coluna "Descrição", na tabela "Parâmetros" omite conteúdo - , ref. ao campo "ABC_XYZ";
• Coluna "Descrição", na tabela "Retorno" omite conteúdo - , vazio

Exemplo - Resultado na Documentação HTML:

Parâmetros

Nome	Tipo	Descrição
cParam1	character	Descrição do parâmetro

Retorno

Tipo	Descrição
NULL	Nenhum

Conteúdo correto esperado

Na Documentação HTML, para este Exemplo:

Parâmetros

Nome	Tipo	Descrição
cParam1	character	Descrição do parâmetro , ref. ao campo "ABC_XYZ"

Retorno

Tipo	Descrição
NULL	Nenhum , vazio

Identificado que em determinados momentos, ao chamar o IntelliSense o VsCode travava e causava auto consumo de CPU.

Após vários testes, foi identificado que havia uma falha na expressão regular que detecta as assinaturas AdvPL suportadas, sempre que a linha posicionada era a declaração de um método WS REST com WSSYNTAX contendo "/", exemplo:

WSMETHOD GET DESCRIPTION "Saldo B2 do Produto" WSSYNTAX "asdfa/sdas/adfa"

CPU-20210226T210330.838Z.cpuprofile (remover .txt para utilizar)

O interpretador de sintaxe das funções, não está considerando funções fora User ou Static.

Tratar expressão para entender também function

Tornar o Snippet @author dinâmico, para que ao ser chamado adicione o nome do usuário conectado ou a configuração autor_default.