Ferramentas do usuário

Ferramentas do site


ti_publica:desenvolvimento_de_sistemas:boas_praticas

Diferenças

Aqui você vê as diferenças entre duas revisões dessa página.

Link para esta página de comparações

Ambos lados da revisão anteriorRevisão anterior
Próxima revisãoAmbos lados da revisão seguinte
ti_publica:desenvolvimento_de_sistemas:boas_praticas [2019/11/29 07:21] cartolati_publica:desenvolvimento_de_sistemas:boas_praticas [2019/11/29 08:09] cartola
Linha 22: Linha 22:
       * **não serve** caso precise de um interpretador específico que não o padrão do sistema       * **não serve** caso precise de um interpretador específico que não o padrão do sistema
   * Se for publicar seu código publique em inglês   * Se for publicar seu código publique em inglês
 +
 +===IDE===
 +
 +Eu uso o vim, mas essas funcionalidades provavelmente poderão ser encontradas em outras IDEs.
 +
 +  * Checagem de sintaxe e auto complemento no VIM
 +    * [[https://github.com/vim-syntastic/syntastic|vim-syntastic]]
 +    * [[https://github.com/ycm-core/YouCompleteMe|vim-youcompleteme]]
 +  * Configurações no .vimrc:
 +    * set textwidth=80
 +    * set wrapmargin=8
 +    * set columns=80
 +
 +===Reuso===
 +  * Ao criar classes/códigos reusáveis, defina a versão (no nível da classe, não da instância)
 +  * Ao criar número de versão no código use tipo string
  
 ===Documentação=== ===Documentação===
Linha 88: Linha 104:
   * Uso de <code python>if __name__ == "__main__":</code> no Python para diferenciar quando o script está sendo chamado diretamente e quando está sendo carregado por outro, visando não executar o programa principal se estiver sendo testado   * Uso de <code python>if __name__ == "__main__":</code> no Python para diferenciar quando o script está sendo chamado diretamente e quando está sendo carregado por outro, visando não executar o programa principal se estiver sendo testado
  
-===IDE=== 
  
-Eu uso vimmas essas funcionalidades provavelmente poderão ser encontradas em outras IDEs.+===Senhas hardcoded=== 
 +Em algumas situações seu programa precisa utilizar senhas. Se sua execução for agendada e não houver uma pessoa para passar a senha na hora, como fazer? Colocar a senha hardcoded? E se seu código estiver sendo guardado num sistema de controle de versão, que é uma boa prática? 
 +  * crie um arquivo de configuração 
 +  * coloque nele apenas permissão de leitura e apenas para o usuário necessário 
 +  * no programa originalopcionalmente, verifique o proprietário e permissão necessária do arquivo de configuração, abortando para garantir acerto se alguém alterar acidentalmente 
 +  * não coloque o arquivo de configuração no sistema de controle de versão ou coloque-o com um pré-nome, tipo config-sample
  
-  * Checagem de sintaxe e auto complemento no VIM +Na prática criei uma função numa biblioteca geral para carregar variáveis de configuraçãopor conta disso meu arquivo de configuração é homônimo ao programa original adicionado de uma extensão padrão.
-    * [[https://github.com/vim-syntastic/syntastic|vim-syntastic]] +
-    * [[https://github.com/ycm-core/YouCompleteMe|vim-youcompleteme]] +
-  * Configurações no .vimrc: +
-    * set textwidth=80 +
-    * set wrapmargin=8 +
-    * set columns=80 +
- +
-===Reuso=== +
-  * Ao criar classes/códigos reusáveisdefina a versão (no nível da classe, não da instância) +
-  * Ao criar número de versão no código use tipo string+
  
 =====Referências===== =====Referências=====
ti_publica/desenvolvimento_de_sistemas/boas_praticas.txt · Última modificação: 2020/09/21 16:12 por cartola