ProtheusDoc-VsCode
ProtheusDoc-VsCode copied to clipboard
Assumir @type function como padrão
Caso não tenha sido definido, assumir @type function, por ser a maioria nos fontes. Com isso diminui significantemente a quantidade de warnings emitidos.
Olá @izacsc , muito interessante tua solicitação.
Estarei verificando e implementando já para próxima versão.
Olá @izacsc ,
estive analisando essa issue pra lançar já na proxima versão, e percebi que a extensão não deixa o atributo @type com "valor default". Ele detecta a assinatura da função, método ou classe e aplica o atributo conforme o tipo.
Portanto não faria sentido deixar function como default, se a geração da documentação já é dinâmica.
Poderia esclarecer melhor sua sugestão?
Bom dia!
A sugestão é para a avaliação e não para a criação de novas documentações. Quando vc já tem uma documentação que não tem o atributo @type, assumir que a documentação se refere à uma function.
Em ter, 16 de mar de 2021 10:52, Gabriel Alencar @.***> escreveu:
Olá @izacsc https://github.com/izacsc ,
estive analisando essa issue pra lançar já na proxima versão, e percebi que a extensão não deixa o atributo @.*** https://github.com/type* com "valor default". Ele detecta a assinatura da função, método ou classe e aplica o atributo conforme o tipo.
Portanto não faria sentido deixar function como default, se a geração da documentação já é dinâmica.
Poderia esclarecer melhor sua sugestão?
— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/AlencarGabriel/ProtheusDoc-VsCode/issues/55#issuecomment-800275210, or unsubscribe https://github.com/notifications/unsubscribe-auth/AADHMGJXSJWXLPXP6GCCY5TTD5PCPANCNFSM4WV2IVGQ .
@AlencarGabriel ficou claro? Preciso esclarecer mais algum ponto?
Ficou claro sim, agora compreendi melhor.
Porém preciso avaliar melhor, pois o atributo @type é um dos obrigatórios, e eu trato ele em diversos pontos da extensão, pra fazer isso que sugeriu eu teria que alterar em todos esses pontos pra considerá-lo como: @type function
default.
- [ ] Tornar todos os atributos opcionais em seu conceito (visto haver uma grande variedades de uso do ProtheusDoc);
- [ ] Criar uma configuração para definir quais atributos ProtheusDoc devem ter validação de omissão;
- [ ] ...