Skip to content

Configurações

Gabriel Alencar edited this page Jul 5, 2021 · 8 revisions

Esta extensão contribui com as seguintes configurações:

Configuração Descrição
"protheusDoc.marcadores_ocultos": [] Ocultar os seguintes atributos não obrigatórios na geração do ProtheusDoc (version, author, since, params, return).
"protheusDoc.autor_default": "" Nome do autor padrão das documentações ProtheusDoc. Caso esteja vazio o autor será o usuário conectado no SO. (Compatível com os snippets: @author, @history e @params).
"protheusDoc.versao_default": "" Versão padrão do identificador das documentações ProtheusDoc.
"protheusDoc.usa_decoracao": true Define se a extensão irá destacar os atributos ProtheusDoc.
"protheusDoc.valida_atributos": true Define se a extensão irá realizar o diagnóstico dos atributos inválidos ou faltantes.
"protheusDoc.usa_workspace_doc": true Define se será adicionado todas as documentações da Workspace na tabela de documentações. Em caso de false somente os fontes que tiveram interação serão adicionados na tabela.
"protheusDoc.usa_sugestao_customizada": true Define se será utilizado a sugestão de palavras customizada da extensão no IntelliSense. Obs.: A configuração padrão editor.suggest.showWords suprime esta.
"protheusDoc.marcadores_nao_validar": [] Atributos opcionais do ProtheusDoc que não serão diagnosticados em sua sintaxe e valor inserido (params, return, history, example, see, obs, link).
"protheusDoc.marcadores_ocultos_hover": [] Atributos da documentação que serão ocultos ao passar o mouse por uma Função, Classe ou Método (params, return, history).
"protheusDoc.diretorio_doc": "" Diretório onde a pasta com os arquivos da documentação serão criados. Caso esteja vazio o diretório usado será o primeiro da Workspace.
"protheusDoc.pasta_doc": "html-out" Nome da pasta que conterá os arquivos da documentação.

Importante:

A documentação das configurações: protheusDoc.include, protheusDoc.exclude e protheusDoc.maxFilesForSearch estão disponíveis na Wiki Tabela de Documentações

Clone this wiki locally