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/04/08 10:41] – [Geral] cartolati_publica:desenvolvimento_de_sistemas:boas_praticas [2019/07/31 11:19] cartola
Linha 8: Linha 8:
  
 ====Geral==== ====Geral====
-  * Use um lint(ou linter) pra checar vários aspectos do código. Ex: [[https://www.pylint.org/]]+  * Use um lint(ou linter) pra checar vários aspectos do código. Ex: [[https://www.pylint.org/|Pylint]] (python), [[https://www.shellcheck.net/|shellcheck]] (shell)
   * Criar testes automatizados   * Criar testes automatizados
   * Não usar linhas maiores que 80 caracteres   * Não usar linhas maiores que 80 caracteres
Linha 14: Linha 14:
  
 ===Variáveis=== ===Variáveis===
-  * Dar nomes descritivos a variáveis e funções +  * Dar nomes descritivos a variáveis e funções, usar sempre mesmos verbos e substantivos 
-  * Adotar camelCase ou snake_case para nomear variáveis e funções+  * Adotar camelCase ou snake_case para nomear variáveis e funções e manter coerência num mesmo código
   * Adotar maiúsculas para constantes   * Adotar maiúsculas para constantes
   * Não usar números diretamente, crie uma constante que diga no nome o que ele é (ex: PI, RAIO_DA_TERRA, etc)   * Não usar números diretamente, crie uma constante que diga no nome o que ele é (ex: PI, RAIO_DA_TERRA, etc)
Linha 22: Linha 22:
  
 ===Funções / Objetos=== ===Funções / Objetos===
-  * Descrever todas as funções+  * Descrever todas as funções nelas mesmas
   * Criar funções pequenas, segmentando o código   * Criar funções pequenas, segmentando o código
   * Eliminar flags booleanos   * Eliminar flags booleanos
Linha 51: Linha 51:
     * vim-syntastic     * vim-syntastic
     * vim-youcompleteme     * vim-youcompleteme
 +    * set textwidth=80
 +    * set wrapmargin=8
 +    * set columns=80
  
 ===Reuso=== ===Reuso===
Linha 67: Linha 70:
   #   #
   #   #
-  # Historico+  # Historico (mais recente em cima)
   #       27.11.2018 - <identificação da pessoa> - Criação   #       27.11.2018 - <identificação da pessoa> - Criação
   #       13.12.2018 - <identificação da pessoa> - Lorem Ipsilum   #       13.12.2018 - <identificação da pessoa> - Lorem Ipsilum
ti_publica/desenvolvimento_de_sistemas/boas_praticas.txt · Última modificação: 2020/09/21 16:12 por cartola