ti_publica:desenvolvimento_de_sistemas:boas_praticas
Diferenças
Aqui você vê as diferenças entre duas revisões dessa página.
Ambos lados da revisão anteriorRevisão anteriorPróxima revisão | Revisão anteriorPróxima revisãoAmbos lados da revisão seguinte | ||
ti_publica:desenvolvimento_de_sistemas:boas_praticas [2019/04/06 17:52] – cartola | ti_publica:desenvolvimento_de_sistemas:boas_praticas [2019/07/31 11:25] – cartola | ||
---|---|---|---|
Linha 4: | Linha 4: | ||
geral. Algumas dicas são genéricas, outras mais adequadas a uma ou outra linguagem. Quando comecei a escrever estava programando principalmente em python, mas também frequentemente em | geral. Algumas dicas são genéricas, outras mais adequadas a uma ou outra linguagem. Quando comecei a escrever estava programando principalmente em python, mas também frequentemente em | ||
shell (principalmente bash) e as vezes em php. No passado já programei em C, pascal, perl, fortran e talvez alguma outra linguagem que não estou lembrando agora. | shell (principalmente bash) e as vezes em php. No passado já programei em C, pascal, perl, fortran e talvez alguma outra linguagem que não estou lembrando agora. | ||
+ | |||
+ | Veja também [[: | ||
=====Para escrever bom código===== | =====Para escrever bom código===== | ||
====Geral==== | ====Geral==== | ||
- | * Use um lint(ou linter) pra checar vários aspectos do código. Ex: [[https:// | + | * Use um lint(ou linter) pra checar vários aspectos do código. Ex: [[https:// |
* 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 16: | ||
===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 |
* Adotar maiúsculas para constantes | * Adotar maiúsculas para constantes | ||
* Não usar números diretamente, | * Não usar números diretamente, | ||
Linha 22: | Linha 24: | ||
===Funções / Objetos=== | ===Funções / Objetos=== | ||
- | * Descrever todas as funções | + | * Descrever todas as funções |
* Criar funções pequenas, segmentando o código | * Criar funções pequenas, segmentando o código | ||
* Eliminar flags booleanos | * Eliminar flags booleanos | ||
Linha 41: | Linha 43: | ||
===Testes automatizados=== | ===Testes automatizados=== | ||
- | * Algumas linguagens já tem frameworks prontos para adiantar esse trabalho, como o [[https:// | + | * Algumas linguagens já tem frameworks prontos para adiantar esse trabalho, como o [[https:// |
* Criar funções ou classes que recebam e retornem parâmetros testáveis | * Criar funções ou classes que recebam e retornem parâmetros testáveis | ||
* Criar outro programa que teste, com os testes programados ou preparar trecho do programa para atuar nos testes | * Criar outro programa que teste, com os testes programados ou preparar trecho do programa para atuar nos testes | ||
Linha 51: | Linha 53: | ||
* vim-syntastic | * vim-syntastic | ||
* vim-youcompleteme | * vim-youcompleteme | ||
+ | * set textwidth=80 | ||
+ | * set wrapmargin=8 | ||
+ | * set columns=80 | ||
===Reuso=== | ===Reuso=== | ||
Linha 67: | Linha 72: | ||
# | # | ||
# | # | ||
- | # Historico | + | # Historico |
# | # | ||
# | # |
ti_publica/desenvolvimento_de_sistemas/boas_praticas.txt · Última modificação: 2020/09/21 16:12 por cartola