Boas práticas na escrita de códigos: Indentação de Códigos

Você está em: Início > Artigos > Desenvolvimento > Metodologia e Praticas > Boas práticas na escrita de códigos: Indentação de Códigos

Olá! Caro leitor neste breve artigo irei trazer uma demonstração muito simples sobre indentação de códigos de programação.

Muito conhecida por profissionais que trabalham na área de desenvolvimento e programação, a palavra indentar um código faz parte da boa prática, para boa leitura, manutenção e atualização de programas, aplicativos ou recursos.

O que significa indentar o código?

Palavra de origem inglesa “indentation”, é um termo usado no código fonte de um programa para ressaltar ou definir a estrutura do algoritmo.

Se você já deu uma pesquisada sobre o assunto já deve imaginar que esta prática esta presente para todos que lidam com programação.

E sim a indentação de Código faz parte da linguagem da programação e assim facilita a vida dos desenvolvedores e programadores para melhor leitura e entendimento do que está acontecendo no código deixando de forma mais evidente onde as coisas começam e terminam.

Para melhor entendimento vou deixar uma ilustração, como programador fica mais fácil pensar que os códigos são divididos em blocos e que cada bloco tem um início e um fim. O que você irá ver a seguir é uma breve demonstração de recuos de textos.

Não pense que só existe um tipo de indentação de código, existem diversos estilos de indentação. E você irá se deparar com esse tipo de cenário sempre que pegar alguma leitura a cerca de boas práticas na programação ou assuntos ligados ao código limpo.

A indentação do código não influencia em como o computador processa as informações do código e as executa, serve somente para nós que estamos desenvolvendo não se perder no processo ou ficar com informações com uma construção tão complexa que torne inviável atualizações e manutenções no código fonte, podendo assim gerar muitas dores de cabeça.

No exemplo a seguir você irá ver um código indentado e outro não indentado em VBA.

Código Indentado

Option Explicit

Sub Macro1 ()
    
    ' Recorded 14/11/2022
    
    Dim s1 As Shape
    Set s1 = ActiveLayer.CreateRectangle(
                                         0.286012,
                                         11.206969,
                                         4.445846,
                                         7.028228
                                         )
    s1.Rectangle.CornerType = cdrCornerTypeRound
    s1.Rectangle.RelativeCornerScaling = TRUE
    s1.Fill.ApplyNoFill
    s1.Outline.SetPropertiesEx 0.006665, 
                               OutlineStyles(0),
                               CreateCMYKColor(0, 0, 0, 100),
    ArrowHeads(0), 
    ArrowHeads(0), cdrFalse, cdrFalse, cdrOutlineButtLineCaps,
    drOutlineMiterLineJoin, 0#, 100, MiterLimit:=5#,
    Justification:=cdrOutlineJustificationMiddle
    s1.Fill.UniformColor.CMYKAssign 0, 100, 100, 0
    s1.ConvertToCurves
    
    Dim crv As Curve
    Set crv = ActiveDocument.CreateCurve
    With crv.CreateSubPath(4.445846, 11.206969)
                            .AppendLineSegment 4.445846,
                                               7.028228
                            .AppendLineSegment 0.286012,
                                               7.028228
                            .AppendLineSegment 4.445846,
                                               11.206969
                            .Closed = TRUE
        
    End With
    
    s1.Curve.CopyAssign crv
    
End Sub

Código Não Indentado

Option Explicit

Sub Macro1()
' Recorded 14/11/2022
Dim s1 As Shape
Set s1 = ActiveLayer.CreateRectangle(0.286012, 11.206969, 4.445846, 7.028228)
s1.Rectangle.CornerType = cdrCornerTypeRound
s1.Rectangle.RelativeCornerScaling = True
s1.Fill.ApplyNoFill
s1.Outline.SetPropertiesEx 0.006665, OutlineStyles(0), CreateCMYKColor(0, 0, 0, 100), ArrowHeads(0), ArrowHeads(0), cdrFalse, cdrFalse, cdrOutlineButtLineCaps, cdrOutlineMiterLineJoin, 0#, 100, MiterLimit:=5#, Justification:=cdrOutlineJustificationMiddle
s1.Fill.UniformColor.CMYKAssign 0, 100, 100, 0
s1.ConvertToCurves
Dim crv As Curve
Set crv = ActiveDocument.CreateCurve
With crv.CreateSubPath(4.445846, 11.206969) .AppendLineSegment 4.445846, 7.028228 .AppendLineSegment 0.286012, 7.028228 .AppendLineSegment 4.445846, 11.206969 .Closed = True
End With
s1.Curve.CopyAssign crv
End Sub

Ambos funcionam, mas um está fácil de ler e compreender já o outro se precisar de manutenção ou atualização ficará mais complicado de trabalhar.

Tabulações ou Espaços

A indentação podo ser feita usando tabulações ou espaços, mas não misture tabulações com espaços, porque tabulações têm tamanhos diferentes em programas diferentes. Se você mistura, código que parece indentado num programa parece sem indentação em outro. Você pode usar alguns recursos nos programas para evitar a mistura de tabulação e espaços, em seu editor utilize a ferramenta exibir tabulações e quais são espaços. Neste momento você irá descobrir aonde foi tabulado e onde foi usado espaços.

Quem utiliza espaços precisa estar atento à configuração do editor. Não faz sentido escrever espaços de um em um, ou apagar de um em um, tentando fazer o alinhamento no olhômetro. O editor deve estar configurado para inserir e remover vários espaços de uma só vez; de maneira a aumentar e reduzir o recuo com um único toque no teclado. Use a tecla TAB para aumentar ou diminuir nível inteiro de indentação, mesmo nas linhas que há estão escritas. É importante configurar a tecla Backspace também para voltar um nível completo.

Tamanho de Indentação

A recomendação é usar 3 ou 4 espaços em cada nível de indentação, acima disso vai gerar um desconforto visual e um desperdício de espaço horizontal. Menos que isso irá dificultar a determinação do nível ao olhar para o código.

Ao utilizar códigos de terceiros não deixe o arquivo com indentações diferentes tente manter um padrão para todo o código e suas partes.

Utilizando recursos online para indentação

Para quem está iniciando pode ocorrer uma dificuldade muito grande de onde usar e como usar os recuos nos códigos, para isso você pode usar ferramentas online que irão organizar os recuos do seu código até que você pegue a prática e não necessite mais do uso de tais ferramentas.

Você pode dar uma conferida em alguns sites que podem te ajudar nesse processo

FreeFormatter: Site muito simples de usar com suporte para várias linguagens web e trás recursos para conversões de arquivos.

Code Beautify: Possui um acervo de linguagens bem amplo e extensão para quem utiliza o chrome, facilitando indentar diversos tipos de linguagens.

Espero que este artigo tenha te ajudado. Utilize o campo de comentários para deixar sua dúvida, sugestão ou até mesmo uma reclamação. (Links e conteúdos somente para backlinks são bloqueados automaticamente)