Neste post não será apresentado códigos, mas sim, uma boa prática do que fazer antes de começar a codificar seus programas. Pois, um erro comum que vejo nos programadores, em boa parte os iniciantes, é que quando recebem uma definição (especificação, documentação) do trabalho a ser executado, já de imediato partem para a codificação, afinal são programadores.
Entretanto, esses profissionais quando estão no processo de programar o que foi requisitado, acabam se deparando com: estrutura lógica incompleta; pontos do documento não compreendidos corretamente ou totalmente; erros na definição; entre outras situações que levam o programador a parar o que estar fazendo, e rever a definição e até mesmo seu código. De modo, que depois de analisar o trabalho feito até o momento, acaba percebendo que está realizando o que foi pedido de maneira errada.
Assim, ocasionando em retrabalho, perca de tempo, estresse, ou seja, interrompendo e atrapalhando todo o fluxo de trabalho do programador, o que não é nada bom. Porque, conduz a atrasos, acumulação de trabalho, e o pior que é a perda da credibilidade do profissional.
Deste modo, com a experiência fica claro que antes de começar a codificar, o programador pode realizar alguns processos para evitar (minimizar) erros que podem vir à interferir no fluxo do seu trabalho. São:
- Ler toda documentação
- ler a definição do que está sendo requisitado, e entender o que estar sendo pedido
- Verificar se o fluxo dos dados estão corretos
- analisar se a estrutura lógica dos dados estar correta, afim de encontrar erros na especificação
- Anotar ou abstrair de maneira ordenada o que deve, como e quando ser feito
- ter em anotado ou em mente o que deve ser feito, para assim não codificar uma funcionalidade antes mesmo que as funções necessárias para está estejam prontas
Uma das situações, que comprovam que os passos acima são necessários, é um simples comparativo em realizar uma refeição. Pois, antes de começar a cozinhar:
| Passos | Preparo de uma refeição | Programar |
| 1 | Ter o livro de receitas . | Ter os documentos necessários para o trabalho |
| 2 | Ler a receita a ser feita, e entender como e quais ingredientes são necessários para preparar a refeição | Ler as especificações , analisar o que deve ser feitoe verificar se o que está definido está correto . |
| 3 | Ter os ingredientes em mãos . | Verificar ou obter as permissões do profissional para a execução do trabalho |
| 4 | Lavar e separar os ingredientes . | Organizar os documentos, local de trabalho, e o fluxo dos passos a serem executados |
| 5 | Rever a receita para verificar se algum ingrediente foi esquecido | Rever a especificação e verificar se os passos definidos para a execução do trabalho está correta |
| 6 | Começar a cozinhar | Começar a programar |
Como podemos observar no comparativo é que antes de começar a cozinhar, há o que ser feito. O que não é diferente para antes de começar a codificar um programa.
Então, com a realização de boas práticas realizadas antes de codificar os programas, com o tempo é facilmente percebido o ganho de tempo, velocidade, e principalmente a diminuição de erros na programação.
Enfim, adote boas práticas no seu trabalho, de como realiza-lo. Não necessariamente devem ser estas, elabore ou busque outras, e tenha em mente que antes de realizar algo, no mínimo deve ser pensado antes de realmente a começar a colocar a mão na massa.
Consultar a relação de Termos e Abreviaturas acesse aqui.
Até o próximo post!
