Bom pessoal, vamos a mais um post sobre desenvolvimento, neste post vou abordar um tema diferente ao invés de falar apenas sobre o desenvolvimento em si, vou falar um pouco sobre conceitos por traz do desenvolvimento de um bom software, e como primeiro post sobre esse tipo de assunto vou abordar um assunto que embora muitos considerem supérfluo, é indispensável para um projeto grande e/ou projetos que busquem uma qualidade maior do código.
Claro que vão ter algumas pessoas pensando agora, o usuário não lê código fonte por que vou fazer algo que organizado?
Bom a resposta disso é bem simples, embora realmente usuário nunca vá ler o código de seu projeto, pode ser que outros programadores, ou até mesmo você precise fazer alguma alteração em algum código que foi criado há muito tempo. E embora alguns ainda possam pensar, “Mas eu sei o que meu código faz”, isso não é uma garantia pois você vai esquecer.
Mas e ai o que seria uma boa pratica de programação ? Essa pergunta me daria conteúdo para alguns artigos gigantescos, pois não existe uma regra obrigatória para seguir, o que eu posso considerar uma boa pratica, ou algo que facilite meu entendimento sobre meu código outros programadores podem discordar completamente de mim. Como não posso escrever algum artigo gigantesco novamente vou ser o mais pratico e simples possível.
Só para ressaltar a importância de um código bem escrito eu fiz um exemplo rápido em C.
#include
int novamente = 1;
float salario,impostoPagar;
int main(int argc, const char * argv[])
{
while (novamente == 1) {
salario = 0;
printf("Entre com seu salario");
scanf("%f",&salario);
if (salario < 1500) { impostoPagar = salario*0.07; }else if ((salario > 1500)&&(salario < 5000)){ impostoPagar = salario*0.18; }else if (salario > 5000){
impostoPagar = salario*0.30;
}
printf("Voce precisa pagar %.2f\n\n",impostoPagar);
printf("Deseja Fazer uma nova Consulta ?\n 1 -- sim \n 2 -- não\n");
scanf("%i",&novamente);
if (novamente == 1) {
}else if (novamente == 2){
novamente = 2;
}else if ((novamente != 1)||(novamente !=2)){
printf("Voce precisa entrar com outro valor");
}
}
return 0;
}
Como esse era um program extremamente simples não há motivo para inserir dezenas de comentários no meio do código.
#include
int x = 1;
float y,z;
int main(int argc, const char * argv[])
{
while (x == 1) {
y = 0;
printf("Entre com seu y");
scanf("%f",&y);
if (y < 1500) { z = y*0.07; }else if ((y > 1500)&&(y < 5000)){ z = y*0.18; }else if (y > 5000){
z = y*0.30;
}
printf("Voce precisa pagar %.2f\n\n",z);
printf("Deseja Fazer uma nova Consulta ?\n 1 -- sim \n 2 -- não\n");
scanf("%i",&x);
if (x == 1) {
}else if (x == 2){
x = 2;
}else if ((x != 1)||(x !=2)){
printf("Voce precisa entrar com outro valor");
}
}
return 0;
}
Com os 2 código um do lado do outro veja qual fica mais fácil de entender ? Se você acha que o segundo esta melhor, bom pode parar de ler o artigo por aqui mesmo.Agora se você prefere o primeiro código vamos continuar.
Já dizia o filósofo “Um programador escreve um código que o computador entende, já um bom programador escreve um código que outros programadores entendam.”
Quando vamos escrever um código e temos interesse em fazer um código bem escrito temos que ter em mente uma coisa as vezes menos pode ser mais.
Isso quer dizer que sim existem situações em que um comentário pode atrapalhar mais do que realmente ajudar em alguma coisa, no exemplo que mostrei logo acima ele é um código extremamente simples e básico se eu colocasse muitos comentários explicando coisas básicas tipo “pega o valor que usuário digitou”, isso seria um comentário inútil. Uma ressalva para casos especiais, um professor ensinando outras pessoas a programar esse tipo de comentário seria quase indispensável.
Mas então, quando seria o ideal para escrever o comentário? Não sejamos hipócritas, somos programadores em algum momento faremos sim uma gambiarra, ou em algum momento de inspiração vamos criar uma lógica extremamente complexa. Nesse tipo de situação não seria bom colocar o comentário, nesses casos é quase obrigatório.
Muito alem de apenas comentários
Boas praticas vão muito alem de definir quando seria uma hora boa ou ruim para um comentário,vamos falar agora sobre outro tema que bem, podemos escrever outro artigo extenso sobre. A indentação, algumas pessoas em especial quando estão começando a programar não dão tanta importância para o tema, porem é indispensável para qual quer código grande.
O conceito pode parecer simples, basta sair encadeando uma linha dentro da outra. E embora possa se resumir a isso, um código bem estruturado pode significar uma um bom tempo na manutenção de um projeto.
Assim como comentários não é só sair dando tabs por ai temos um “padrão a seguir”, a estrutura mais comum, funciona da seguinte maneira. Imagine um IF que execute uma determinada função, nossa função estaria um “nível abaixo”, agora se esse método executa outro if com seu respectivo bloco de código, esse bloco estaria um “nível abaixo”, praticamente formando uma escada.
Podemos ver esse tipo de encadeando no primeiro código que mostrei no inicio do post.
Lembrando que não é necessariamente obrigatório que um programador siga as boas praticas, porem os que usam alem de facilitar a manutenção de seus projetos, também demonstra uma maturidade maior como programador.
E claro que boas praticas não se resumem apenas em quando usar comentários, como indentar códigos, temos ainda muitos outros temas que não posso abordar nesse post, pois ele ficaria muito extenso, se os leitores se interessarem podemos fazer um post sobre outros temas importantes que deixei de mencionar.
E ai tem outras praticas que acha importante que seja comentado ? Tem alguma duvida ? Alguma coisa que deixei de mencionar ? Mande seu comentário.
