Skip to content

Tabela de documentações

Gabriel Alencar edited this page May 16, 2020 · 3 revisions

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

Ela é utilizada pelo Hover para apresentar as documentações dos identificadores posicionados baseado na Workspace aberta.

Sempre que um projeto (ou workspace) AdvPL é aberto, a extensão irá varrer os arquivos permitidos da Workspace (verificar a configuração protheusDoc.include no VsCode) em busca de documentações ProtheusDoc.

Importante:

Caso a Workspace aberta possua uma quantidade considerável de arquivos com documentações ProtheusDoc, o uso de memória e CPU do VsCode poderá aumentar de forma considerável. Mas a tendência é que depois que a API varrer os arquivos a utilização diminua, pois esta é bem performática.

Para minimizar os impactos negativos no ambiente de desenvolvimento nesses casos, é importante que as configurações protheusDoc.include, protheusDoc.exclude e protheusDoc.maxFilesForSearch estejam definidas conforme o melhor cenário para o projeto.

Desativar Tabela de Documentações:

Caso o uso da tabela de documentações na Workspace seja desativado ("protheusDoc.usa_workspace_doc": false), somente os arquivos que tiverem interação no editor serão adicionados na tabela conforme são abertos ou alterados.

É possível forçar a atualização da tabela de documentações a qualquer momento, utilizando o comando: ProtheusDoc - Atualizar tabela de documentações desde que a configuração "protheusDoc.usa_workspace_doc": true.

A tabela é sempre limpa quando as pastas da Workspace são alteradas.

Clone this wiki locally