A ADVPL suporta dois tipos de comentários, comentários de implementação “/* */” e comentário de documentação “//”.

Comentários de implementação tem como objetivo desabilitar temporariamente um grupo de comandos, porém pode ser utilizado no padrão de documentação de fontes, funções/métodos, ProtheusDoc.

Comentários de documentação devem resumir o código-fonte e dar informações adicionais que não poderão ser lidas diretamente no código-fonte. Esses comentários devem conter somente informações relevantes para a leitura e entendimento do programa.

Discussões sobre decisões não obvias ou não triviais no design do código-fonte são bem vindas, porém evite duplicar informações que já estão presentes de forma clara no código-fonte. Comentários redundantes podem facilmente se tornarem desatualizados, evite comentar informações que tem o potencial de se tornarem desatualizados.

  • Sem rótulos