search

AlencarGabriel / ProtheusDoc-VsCode

Repositório para implementação dinâmica do ProtheusDoc do TDS para VsCode
https://marketplace.visualstudio.com/items?itemName=AlencarGabriel.protheusdoc-vscode
27 stars 6 forks source link

Parâmetro Opcional no ProtheusDoc #50

Closed carloseniemeyer closed 3 years ago

carloseniemeyer commented 3 years ago

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.

AlencarGabriel commented 3 years ago

Olá @carloseniemeyer ,

desde já obrigado por sua issue. Sua solicitação é bastante interessante, visto que na versão do antigo TDS Eclipse isso funcionava realmente: image

Na época que desenhei essa extensão havia deixado de lado essa questão. Mas vou analisar sua solicitação e realizar os ajustes necessários.

Obrigado por informar, qualquer coisa relacionado a isso volto a falar por aqui.

carloseniemeyer commented 3 years ago

Excelente notícia!

AlencarGabriel commented 3 years ago

Olá @carloseniemeyer ,

venho informar que a implementação solicitada já foi desenvolvida, tanto aqui no lado da extensão, quando na dependência da documentação HTML (robsonrosilva/protheusDoc#4).

Resultado na extensão: image

Agora não irá mais causar erros no diagnóstico quando o parâmetro for opcional, e no hover será informado.

Resultado no HTML: image

Aguardando apenas a liberação do novo pacote da dependência, para lançamento da próxima versão aqui da extensão ProtheusDoc.

AlencarGabriel commented 3 years ago

Documentação da feature: https://github.com/AlencarGabriel/ProtheusDoc-VsCode/wiki/Hover-de-documentações#parâmetros-opcionais