Marque os seus comentários, uma característica dos criadores para criadores

Os comentários são essenciais na vida de um promotor. Quando trabalhamos numa nova funcionalidade, acrescentamos frequentemente comentários que são lembretes. Por exemplo:

• para validar uma parte do código com um colega,
• para refactor uma função,
• para corrigir o código que está a atrasar o desempenho,
• para dividir um método ou uma classe em secções,
• para preparar o esqueleto de uma classe e acrescentar um comentário completo dentro de cada função.

Mesmo que escreva algum código simples, tente lê-lo meses ou anos mais tarde. Continuará a parecer simples, ou gostaria de ter acrescentado comentários?

4D v19 R4 leva os comentários a um nível completamente novo com etiquetas de comentários que lhe permite organizar melhor os seus comentários.

Há três novas etiquetas à sua disposição:

• MARCAR
• TODO
• FIXME

Neste post de blog anterior, mostrámos-lhe uma lista no editor de códigos, permitindo-lhe navegar facilmente dentro da sua classe. Os comentários precedidos por estas três etiquetas são também mostrados nesta lista.

Pode utilizá-los dentro das suas classes ou métodos.

Como utilizá-los

A etiqueta MARK permite-lhe dividir o seu código em secções. Pode escrevê-lo de três maneiras diferentes. As outras duas etiquetas TODO e FIXME, são escritas da mesma forma. O benefício é que têm ícones diferentes na lista, o que lhe permite organizar o seu código para dar prioridade às suas acções futuras.

Aqui está um exemplo com uma classe ORDA:

As funções e as etiquetas de comentários são apresentadas na sua ordem de aparecimento dentro da classe e método. Se preferir, pode exibir as funções e as etiquetas de comentário de uma classe em ordem alfabética, segurando Cmd no MacOS ou Alt no Windows antes de implementar o menu.

O que se segue?

Pronto para intensificar o seu jogo de codificação com esta nova funcionalidade? Diga-nos o que pensa sobre esta nova possibilidade de organizar o seu código e navegar nas suas classes ou métodos. Esperamos por si no fórum.