[Carlos - Tutorial] Indentação.

Nome: Indentação.
Descrição: Uma breve descrição de como fazer um bom código.
Nível de Dificuldade: Iniciante.
Requerimentos: Qualquer coisa onde se possa escrever.

E a e pessoal, tudo bem, esse tutorial será breve (pelo menos eu acho), vou explicar como usar a indentação não só para uma boa estética mas também para uma boa leitura de seu código fonte.
A indentação e fundamental quando se trabalha em equipe, pois você terá que fazer um código onde todos de sua equipe possam entender o que está escrito, e não só você.
Muitas pessoa devem pensar ‘Para que fazer tudo arrumadinho não faz diferença.’, quando você começar a fazer coisas grandes além de bolas se mexendo você notará a diferença, disso você pode ter certeza.
Existem vários tipos de indentação não vou entrar em detalhes dos tipos somente dar uma breve explicação de como usar um estilo de indentação que considero o melhor que é o Estilo Allman, ele é bem simples vou demostrar uns exemplos e vocês notarão a diferença entre um código indentado e um não indentado.
// SEM INDENTAÇÃO.
if (keyboard_check(vk_right)) {hspeed = velocidade;}
// OU
if (keyboard_check(vk_right))
{
hspeed = velocidade;
}

// COM INDENTAÇÃO.
if (keyboard_check(vk_right))
{
hspeed = 5;
}
Se você reparou bem você notou um breve espaçamento entre a condição e o que aquela condição executará se for verdade, mas, como o código e pequeno não faz tanta diferença, uma dica que posso dar para códigos pequenos e retirar as chaves e dar um pequeno espaçamento no código da seguinte maneira.
if (keyboard_check(vk_right))
hspeed = 5;
Assim fica bem mais organizado, não fica.
Agora para você 'chato' que deve estar pensando 'Aiai não vi diferença nenhuma seu noobão', eu vou lhe mostrar como a indentação exerce um papel importante na organização de um bom código preste atenção.
// SEM INDENTAÇÃO.
if (voceEstaLendo == true){if (seuCodigo == Ruim){voceProgramaAssim = true
}else{voceProgramaAssim = false}}
Reparou que ele está horrível. Se você entregar um código assim para alguém não reclame se ele(a) lhe xingar e falar que não entendeu nada. Agora vamos ver o mesmo código com a indentação de Allman.
// COM INDENTAÇÃO.
if (voceEstaLendo == true)
{
if (seuCodigo == Ruim)
{
voceProgramaAssim = true;
}
else
{
voceProgramaAssim = false;
}
}
Prestou atenção na diferença, esse tipo de indentação e superfácil, olhe a imagem abaixo e veja como é feito.

Viu! Após cada chave e colocado um espaçamento onde esse espaçamento pode ser dado pressionando a tecla TAB.

Pronto era isso que queria passar pro pessoal, comecem a treinar um pouco o estilo como escreve seu código e você notará a diferença. Outra maneira de organiza-lo para quando se quiser localizar algo e colocando comentário, preste atenção comentário não um texto descrevendo o código, espero que o pessoal siga a dica.

OBS: Caso você queira saber mais sobre indentação olhe no Wikipedia mas em inglês porque o wikipedia com as matérias em português e uma vergonha.

Muita gente vai olhar esse tuto e vai pensar que é besteira, mas com certeza NÃO É!
Facilita e muito fazer os códigos todos arrumadinhos assim, uma vez eu tive que refazer todo um projeto, pois nem eu estava mais me achando nos códigos

Outra coisa que é boa também, é colocar comentários em cada grupo de ações, colocar só bem no topo antes desse grupo de códigos o que ele é,por exemplo: //movimentação, //troca de sprites , e assim vai. Eu acho que fica bem mais fácil de se programar assim.

parabéns pelo tuto cara ficou bem legal mesmo

Heh! Já tava na hora de alguem dar uma luz pro povão!

Tem vezes que o pessoal cria tópicos pedindo ajuda para arrumar os códigos, eu só consigo ajudar quando eu faço a identação (não sabia o nome disso), pois fica muito mais fácil de entender.

Acreditem, vocês que se auto-chamam de "noobs", começem a tornar a identação um hábito, pois ai, vocês vão ter mais flexibildiade com seus propios códigos e vão dizer:

Zézinho que não usava identação escreveu:Ei! Eu não sou noob, eu só não entendia o que eu fazia!

LCS escreveu:Muita gente vai olhar esse tuto e vai pensar que é besteira, mas com certeza NÃO É!
Facilita e muito fazer os códigos todos arrumadinhos assim, uma vez eu tive que refazer todo um projeto, pois nem eu estava mais me achando nos códigos

Outra coisa que é boa também, é colocar comentários em cada grupo de ações, colocar só bem no topo antes desse grupo de códigos o que ele é,por exemplo: //movimentação, //troca de sprites , e assim vai. Eu acho que fica bem mais fácil de se programar assim.

parabéns pelo tuto cara ficou bem legal mesmo

Valeu, com certeza muita gente vai olhar e dizer que é besteira, mais fazer o que cada um tem o direito de pensar o que quiser.

Willy escreveu:Heh! Já tava na hora de alguem dar uma luz pro povão!

Tem vezes que o pessoal cria tópicos pedindo ajuda para arrumar os códigos, eu só consigo ajudar quando eu faço a identação (não sabia o nome disso), pois fica muito mais fácil de entender.

Acreditem, vocês que se auto-chamam de "noobs", começem a tornar a identação um hábito, pois ai, vocês vão ter mais flexibildiade com seus propios códigos e vão dizer:

Zézinho que não usava identação escreveu:Ei! Eu não sou noob, eu só não entendia o que eu fazia!

Parabéns pelo tutorial!

Com certeza o pessoal precisa melhorar a indentação e tornar um hábito, as vezes da até desanimo em ajudar alguém quando vem com aquele código onde parece um monte de 'garrancho digital'

Zézinho que não usava indentação escreveu:Ei! Eu não sou noob, eu só não entendia o que eu fazia!

Essa foi boa.

PS.: Valeu por comentar LCS e Willy.

Sempre seus tutoriais superam !! Adoro todos ! Parabéns

.:Allison:. escreveu:Sempre seus tutoriais superam !! Adoro todos ! Parabéns

Obrigado, mas seus tutoriais e suas Aulas também são bons.

Ótimo tutorial!
Indentação é muito importante, ainda mais se for um projeto em grupo. Indentação ajuda a evitar erros no código e facilita na hora de encontrar os bugs também.
Vale lembrar que comentar o código para explicar, mesmo que resumidamente, também é uma boa prática, mas não vá exagerar e falar o que já está escrito:

if (tempo > 0) //Se o tempo for maior que 0 <--- Obvio.
{
tempo -= 1; //Diminui 1 na variável tempo. <--- Obvio.
}

O comentário deve explicar algo que não está explicito, por exemplo:

if (tempo > 0) //Sistema de Tempo
{
tempo -= 1; //Tempo em STEPS. 30 steps = 1 Segundo
}

Janx escreveu:Ótimo tutorial!
Indentação é muito importante, ainda mais se for um projeto em grupo. Indentação ajuda a evitar erros no código e facilita na hora de encontrar os bugs também.
Vale lembrar que comentar o código para explicar, mesmo que resumidamente, também é uma boa prática, mas não vá exagerar e falar o que já está escrito:

if (tempo > 0) //Se o tempo for maior que 0 <--- Obvio.
{
tempo -= 1; //Diminui 1 na variável tempo. <--- Obvio.
}

O comentário deve explicar algo que não está explicito, por exemplo:

if (tempo > 0) //Sistema de Tempo
{
tempo -= 1; //Tempo em STEPS. 30 steps = 1 Segundo
}

Valeu por comentar, e sobre os comentários eu coloquei uma pequena observação.

'Outra maneira de organiza-lo para quando se quiser localizar algo e colocando comentário, preste atenção comentário não um texto descrevendo o código'.

Nossa, muito bom! Eu já uso a identação a algum tempo, depois de alguns jogos meus que nem eu entendia as coisas direito... Só que eu não sabia que o nome era esse, pra mim identação era organização... mas os dois terminam com ação, entao era a mesma coisa