Hover de documentações
A partir da versão 0.4.0 da extensão, foi disponibilizado um recurso para visualizar as documentações de uma função, método ou classe apenas passsando o mouse pelo identificador.
Ao passar o mouse por um identificador, a rotina irá consultar na tabela de documentações se existe uma documentação ProtheusDoc para o identificador em questão.
A feature reconhece e apresenta (caso disponível) o tipo do identificador, descrição, parâmetros, retorno, histórico de alterações e a localização da definição.
Para escolher quais informações deseja ocultar no Hover utilize a configuração
protheusDoc.marcadores_ocultos_hover. Veja mais na Wiki de Configurações.
Obs.: A extensão identifica a documentação mesmo se for uma chamada de User Function:
Importante:
Recomendamos não utilizar o caractere
@nas descrições das documentações, pois este é um caractere especial usando para identificar atributos do ProtheusDoc. O uso de@pode acarretar em quebras inesperadas ao apresentar as documentações pelo Hover.
Na linha de localização, existe uma referência ao arquivo onde a documentação em questão foi declarada. Ao clicar sobre o link, o VsCode abrirá o arquivo que contém a declaração e posicionará no início da documentação.
É possível que hajam identificadores (funções, métodos ou classes) com o mesmo nome na Workspace, ou ainda que arquivos duplicados causem essa situação.
Sendo assim, caso um mesmo identificador esteja duplicado na Workspace, será apresentado somente as ocorrências do mesmo arquivo, se não todas as ocorrências de documentação da Workspace.
Para que no início da visualização da documentação seja apresentado a demonstração da estrutura de código, é necessário que a propriedade @type do ProtheusDoc esteja definida no bloco de documentação do identificador.
Caso este esteja omitido ou inválido, será apresentado apenas o nome do identificador.
A extensão suporta e trata o uso de parâmetros opcionais nas documentações. Para destacar um parâmetro como opcional, basta colocar o nome do parâmetro desejado entre colchetes: [nome_parametro]. Quando um parâmetro é opcional, o hover irá destacá-lo informando que é opcional.
Obs.: Na documentação HTML é exibido se o parâmetro é de uso opcional ou obrigatório.
