Frameworksp

Atalhos

Páginas filhas
  • Comentários

Documento: Comentários


Os comentários são observações feitas pelo programador dentro dos programas e que não serão executadas pelo compilador da linguagem. Elas servem para documentar o objetivo do programa e algumas passagens, como cálculos e fórmulas, que são importantes.

A inclusão de comentários nos códigos dos programas é extremamente importante para torná-los mais claros, fáceis de serem compreendidos e, consequentemente, mais fáceis de serem alterados ou corrigidos. O AdvPL permite a inclusão de vários tipos de comentários, como mostraremos abaixo e como também se pode observar no nosso exemplo de programa.

 
  • Várias linhas
 
Diversas linhas de comentários podem ser incluídas dentro do código dos programas, desde que sejam iniciadas por uma barra seguida por um asterisco ( /* ) e finalizadas por um asterisco seguido por uma barra ( */ ). Qualquer caracter pode ser incluído nesse tipo de comentário, inclusive <Enter> ou <Return> para a mudança de linha.

Exemplo:

/*
Esse programa tem o objetivo de controlar o Cadastro de Clientes.
O usuário tem a opção de pesquisar, incluir, alterar, excluir e visualizar as informações de cada cliente.
*/
 
  • Uma única linha

 

Para incluir apenas uma linha de comentário entre as linhas de instruções de um programa, deve-se precedê-la por duas barras ( // ). Neste caso, quaisquer caracteres após as barras, até o próximo <Enter> ou <Return> que causa uma mudança de linha, serão ignorados pelo compilador do AdvPL.

Exemplo:

// Calcula o faturamento líquido com base nas Receitas Brutas e nas Despesas.
nDespesa := nOperac + nFinanc
nFatLiq := nRecBrut - nDespesa
 
 
  • Final de uma linha

 

As barras duplas ( // ) também podem ser utilizadas para iniciar um comentário no final de uma linha de instrução do programa. Quaisquer caracteres que estiverem após as barras, até o final da linha, serão ignorados pelo compilador.

Exemplo:

nDespesa := nOperac + nFinanc
nFatLiq := nRecBrut - nDespesa   // Calcula o faturamento líquido com base nas Receitas Brutas e nas Despesas.

 

  • Protheus.doc

 

Esse tipo de comentário é o mais indicado para documentar as informações de uma rotina ou de funções. Trata-se de uma ferramenta que lê um cabeçalho formatado dentro de determinadas regras para obter os comentários e as informações da função, tais como Autor, Data, Nome da função, Parâmetros, Retorno, Versão, etc.

Essa ferramenta é explicada com mais detalhes na página "Documentando o programa com o Protheus.doc", dentro do item Boas Práticas de programação.

 

  • Sem rótulos