Páginas filhas
  • Comentários Compactos - Comentários - Práticas e técnicas de programação

É fato que bons comentários são importantes, ainda assim eles ocupam certo espaço na tela e gastam certo tempo do leitor. Por isso os comentários devem ser os mais compactos e objetivos possível.

 

Ideia chave: Comentários devem ter o máximo de informação no menos espaço possível.

 

Os comentários serão lidos por pessoas técnicas e não leigos, então não é necessário escrever uma narrativa completa, apenas seja objetivo e escreva o que importa, de uma maneira que outro analista entenda.

 

Para treinar (enquanto não se tem prática) e facilitar a compactação de comentários sem perder a precisão dos detalhes, pode-se escrever primeiramente um logo comentário e depois refatorá-lo até que fique bom.

  • Sem rótulos