Introdução à Programação com o UCB Logo/Indentação de Código

O termo indentação é utilizado para indicar que os elementos de um código fonte estão hierarquicamente dispostos através de avanços em relação à posição zero de cada linha. Na maioria das linguagens de programação a indenteção possui um papel meramente estético, tornando a leitura do código muito mais fácil. Isto torna mais fácil a elaboração de um código, pois facilita a organização do raciocínio. Além disso, um código indentado é mais facilmente compreendido por terceiros, facilitando também a sua manutenção e reaproveitamento. Existem, no entanto, algumas linguagens que utilizam a indentação para marcar blocos no código, e portanto é obrigatória a indentação do código, como por exemplo na linguagem Python.

Exemplo

Vamos utilizar como uma função para criar um polígono. Esta função recebe dois parâmetros: o número de lados do polígono e o tamanho dos lados do polígono. O código desta função é ilustrado abaixo:

to poligono :N :L
repeat :N [fd :L rt 360/:N]
end

Para melhor organizar o código, vamos utilizar a indentação. Todos os comandos que ocorrem dentro da função poligono serão apresentados com um certo afastamento em relação ao início do código da função. O que a função faz é repetir um procedimento N vezes, onde N é o número de lados do polígono. O procedimento que será repetido está hierarquicamente um nível abaixo, e portanto deverá estar deslocado à direita com relação aos procedimentos do nível hierárquico superior. Dentro do procedimento de repetição são executados apenas dois comandos. Cada um é disposto então em uma linha, para ficar claro que são dois procedimentos diferentes. Como estes dois procedimentos estão no mesmo nível de hierarquia, eles devem apresentar o mesmo afastamento em relação ao nível hierárquico superior. Veja como ficou o código após a sua indentação:

to poligono :N :L
   repeat :N [
       fd :L 
       rt 360/:N
   ]
end

Comentários

Outra boa prática é acrescentar comentários. Os comentários que são colocados logo após a definição do nome do procedimento são os comentários de help deste procedimento. Veja o exemplo abaixo e execute o help deste procedimento para ver o que será exibido na tela. O help do procedimento serve para que outras pessoas saibam o que faz o procedimento que você criou, e como elas podem utilizar. As vezes é interessante incluir também algum exemplo de utilização.

Ao longo do código pode ser importante acrescentar comentários para que você e outra pessoa que venha a ler o seu código possa entender com maior facilidade o que cada trecho do código faz.

to poligono :N :L
; forma de utilização:  poligono :N :L
;   N é o número de lados do polígono
;   L é o tamanho dos lados
:
; exemplo:
;    desenhar um quadrado de lado 100: poligono 4 100
;    desenhar um triangulo de lado 100: triangulo 3 100
   repeat :N [     ; para cada lado do polígono faça:
       fd :L       ;   andar para frente L passos
       rt 360/:N   ;   virar para a direita 360/L graus
   ]
end

Agora você poderá desenhar qualquer polígono passando como parâmetro o número de lados e o tamanho de cada lado.