search

OpenSourceCommunityBrasil / REST-DataWare

Repositório oficial do pacote Rest Dataware para Delphi e Lazarus
GNU General Public License v3.0
146 stars 43 forks source link

[Feature Request] Documentação dos fontes no código pra facilitar uso. #146

Open mobius1qwe opened 1 year ago

mobius1qwe commented 1 year ago

Descrição da sugestão Documentar brevemente o que as funções fazem no fonte através de comentários na assinatura dos métodos, por exemplo:

// Método que dispara uma mensagem após clicar no botão
procedure ButtonClick(Sender: TObject);
begin
  showmessage('blah');
end;

Motivo da Mudança Dessa forma a documentação consegue ser automatizada e facilita o entendimento do usuário que for ler o código.

joseh-henrique commented 1 year ago

Caso a função/procedure tenha históricos de problemas, onde determinado parâmetro causa determinado efeito, tem que ser informado. Resumindo não apenas informando para que serve, mas o conjunto todo, função/procedure e seus parâmetros.

mobius1qwe commented 1 year ago

Caso a função/procedure tenha históricos de problemas, onde determinado parâmetro causa determinado efeito, tem que ser informado. Resumindo não apenas informando para que serve, mas o conjunto todo, função/procedure e seus parâmetros.

Se quiser contribuir só fazer um PR que será muito bem aceito!

joseh-henrique commented 1 year ago

Daria para ajustar, corrigir, mas escrever a parte inicial, é para quem conhece a fundo ;-)

Em qui., 17 de nov. de 2022 às 16:10, Mobius One @.***> escreveu:

Caso a função/procedure tenha históricos de problemas, onde determinado parâmetro causa determinado efeito, tem que ser informado. Resumindo não apenas informando para que serve, mas o conjunto todo, função/procedure e seus parâmetros.

Se quiser contribuir só fazer um PR que será muito bem aceito!

— Reply to this email directly, view it on GitHub https://github.com/OpenSourceCommunityBrasil/REST-DataWare/issues/146#issuecomment-1319082150, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAJ5JB6S3ZCFVJPWHTDM5W3WIZ7JJANCNFSM6AAAAAASDWKFCU . You are receiving this because you commented.Message ID: @.***>

-- Joseh-Henrique Goiania, GO