Comentários seccionais

Já imaginou ler um livro sem formatação alguma? Quando mesmo começa aquele capítulo? E quando aquele personagem faz tal coisa? Por isso os editores têm a preocupação em ter uma boa formatação em seus livros. E por que com código seria diferente? Com isso gostaria de introduzir o conceito de comentários seccionais.

O que são?

São comentários onde sua existência é mais importante do que seu conteúdo. Vamos ver o exemplo abaixo:

Como podem ver, existem dois tipos de comentário nesse arquivo, os de uma linha e os compostos. Os compostos possuem um espaço maior, algo como servissem de título ou header para cada seção do código. Para que possam ser vistos facilmente no mini código que fica ao lado.

Agindo como uma certa forma de índice para o código, podendo pular facilmente para as áreas de interesse. Mas mais importante do que está escrito dentro do comentário, é ele em si. Pois podemos facilmente ver as divisões de organização.

Mas por que usar isso? Além do visível contraste de cor que ressalta aos olhos, ter que ler o código (mesmo que seguindo boas práticas de nomeação) pode ser mais lento dependendo do intuito do código que pode se mostrar levemente obtuso. Como eu havia dito, existem os comentários secionais compostos e de linha. Os de linha servem para separar em mini seções dentro de uma seção pai, como agrupar variáveis ou funcionalidades.