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/07/31 11:19] – cartola | ti_publica:desenvolvimento_de_sistemas:boas_praticas [2019/11/21 10:59] – [Geral] 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===== | ||
Linha 9: | Linha 11: | ||
====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 | + | * Crie testes automatizados |
- | * Não usar linhas maiores que 80 caracteres | + | * Não use linhas maiores que 80 caracteres |
- | * Crie e use bibliotecas de funções | + | * Crie e use bibliotecas de funções: não faça blocos de código longos |
+ | |||
+ | ===Documentação=== | ||
+ | * Use um cabeçalho em cada arquivo de código: | ||
+ | * Descrição do propósito, parâmetros, | ||
+ | * Autor | ||
+ | * Histórico | ||
+ | * A fazer | ||
+ | * Comente os blocos: funções, classes, métodos, loops, variáveis ... | ||
+ | * Pylint pede doc para o arquivo, funções e classes, por exemplo | ||
+ | * vim-youcompleteme fornece as docs de funções ao digitar seus nomes | ||
+ | |||
+ | **Exemplo de cabeçalho padrão (python): | ||
+ | |||
+ | # | ||
+ | # -*- coding: UTF-8 -*- | ||
+ | # | ||
+ | # < | ||
+ | # | ||
+ | # | ||
+ | # Historico (mais recente em cima) | ||
+ | # | ||
+ | # | ||
+ | # | ||
+ | # A Fazer | ||
+ | # - Tarefa 1 | ||
+ | # - Tarefa 2 | ||
+ | # - subtarefa 2.1 | ||
===Variáveis=== | ===Variáveis=== | ||
Linha 48: | Linha 77: | ||
===IDE=== | ===IDE=== | ||
- | | + | Eu uso o vim, mas essas funcionalidades provavelmente poderão ser encontradas em outras IDEs. |
- | * vim-syntastic | + | |
- | * vim-youcompleteme | + | |
+ | * [[https:// | ||
+ | * [[https:// | ||
+ | * Configurações no .vimrc: | ||
* set textwidth=80 | * set textwidth=80 | ||
* set wrapmargin=8 | * set wrapmargin=8 | ||
Linha 58: | Linha 90: | ||
* Ao criar classes/ | * Ao criar classes/ | ||
* Ao criar número de versão no código use tipo string | * Ao criar número de versão no código use tipo string | ||
- | |||
- | |||
- | ===ETC=== | ||
- | |||
- | **Exemplo de cabeçalho padrão (python):** | ||
- | |||
- | # | ||
- | # -*- coding: UTF-8 -*- | ||
- | # | ||
- | # < | ||
- | # | ||
- | # | ||
- | # Historico (mais recente em cima) | ||
- | # | ||
- | # | ||
- | # | ||
- | # A Fazer | ||
- | # - Tarefa 1 | ||
- | # - Tarefa 2 | ||
- | # - subtarefa 2.1 | ||
=====Referências===== | =====Referências===== |
ti_publica/desenvolvimento_de_sistemas/boas_praticas.txt · Última modificação: 2020/09/21 16:12 por cartola