Protheus :: Programação Básica em Advpl “Combo III”

Comentários:

O compilador Advpl ignora as linhas em branco e a indentação. Ambas tornam o programas mais legível e, devemos abrir mão deste recurso para tornar os programas mais legíveis. Os comentários também são ignorados pelo compilador.

Na realidade, as linhas em branco, a identação e os comentários nos programas são tratados pelo pré-processador.

No Advpl são permitidas as seguintes formas de se comentar um programa:

//Para efetuar o comentário em uma linha. ( Tudo o que estiver à direita //das ( // ) será considerado como um comentário.

Obs.: Pode-se utilizar o sinal de * ou && no inicio da frase para se efetuar o comentário de uma única linha. Deve-se escolher uma por padrão e ser coerente.

/*
Para efetuar o comentário em mais de uma linha. ( Tudo o que estiver entre ( /* e */ ) será considerado como comentário.
*/

Obs.: para facilitar a utilização do modelo de comentário acima utilize /*/ para abrir o comentário e /*/ para garantir que um comentário nunca deixará de ser fechado.

É altamente recomendável que as rotinas importantes e de utilidade sejam comentadas com um bloco de abertura. Deverão ser especificados: o propósito da rotina, os tipos de parâmetros e, se for uma função que retorna algo, o valor de retorno.

/*/
Função : SomaUm( nLast )
Autor : Marinaldo de Jesus
Data : 18/02/2005
Versão : 1

SomaUm( nLast ) -> Retorna valor de nLast incrementado de 1
nLast -> Valor onde deverá ser somado um
/*/

Obs.: A melhor documentação de um programa é o próprio programa ( desde que bem escrito e seguindo-se as regras que foram estabelecidas )