Usar os comentários

O Explorador permite associar comentários aos objetos em seu banco de dados. O uso de comentários é especialmente apropriado para bancos desenvolvidos por vários programadores e geralmente é uma boa prática em programação. Seus comentários são visíveis na área de visualização prévia do Explorador.

Os seguintes tipos de objetos aceitam o uso de comentários:

• pastas
• métodos (banco, componentes, projeto, triggers e formulário),
• formulários,
• tabelas,
• campos,
• plug-ins

Um comentário 4D se apresenta como texto, (os caracteres podem ter diferentes estilos de fontes, cores, etc..) modificável e visível a qualquer momento no ambiente Explorador. POde conter uma descrição do objeto a que está associado, assim como também toda informação necessária para entender o funcionamento do banco. Os comentários são guardados na estrutura do banco.

Adicionalmente, pode gerar comentários automáticos, ou seja, comentários cujo conteúdo é atualizado automaticamente por 4D quando um objeto é criado ou modificado.

Nota de compatibilidade: desde a versão 12 de 4D, os comentários inseridos no cabeçalho de um método utilizando os caractere // são mostrados como mensagens de ajuda quando o método é referenciado em outro método  (ver o parágrafo "Utilizar as mensagens de ajuda"  na seção WA SET EXTERNAL LINKS FILTERS. Esta função, muito útil para documentar os métodos usuário, não é compatível com os comentários no Explorador. Se deseja  utilizar os cabeçalhos dos métodos desta forma, não introduza comentários no  Explorador.

Pode criar, ver e modificar os comentários no Explorador. Para adicionar um comentário quando se mostra a área de visualização prévia, selecione o objeto na lista do Explorador, e logo clique no botão Comentários localizado na parte inferior da área de visualização prévia.

4D Server: o ícone de bloqueio, localizado na esquina inferior esquerda da área, indica se o comentário está sendo editado por outro usuário. Se esse for o caso, o lápis aparece com uma barra diagonal e somente se pode ler o comentário.

Pode melhorar o estilo dos comentários (colocando negrito ou itálico) e mudar a fonte dos caracteres ou sua cor:

1. Selecione o texto que deseja modificar na área Comentários.
2. Clique com o botão direito na área.
3. Aparece um menu hierárquico expandível
4.   
5. Seleccione los atributos que quiere aplicar al texto.

É possível ativar um sistema de comentários automático, apenas para os métodos e formulários do banco de dados. Quando esse sistema estiver ativo, um comentário se associa automaticamente a cada método ou formulário criado ou modificado no banco de dados. Um comentário automático pode conter texto estático (como "Modificado por") e elementos variáveis (data, hora e usuário atual, como definido na tabela de senhas de 4D)

Os comentários automáticos são definidos na caixa diálogo de Propriedades do banco, Página Geral (ver o parágrafo ). Do mesmo jeito que os comentários padrão, eles podem ser vistos no Explorador. 

Para ativar o sistema de comentários automáticos:

1. Abra a caixa de diálogo de Propriedades através do comando Propriedades do banco... do menu Desenho ou clicando no botão Propriedades da barra de ferramentas de 4D.
2. Na página Geral, selecione a opção Ativar os comentários automáticos. 
3. Introduza o texto dos comentários.
   Pode inserir textos estáticos e elementos variáveis utilizando os botões
   Data, Hora e Usuário localizados na área. Também pode introduzir diretamente as seguintes variáveis:
   #D para a data
   #H para a hora
   #N para o usuário atual

Por exemplo, se introduzir os seguintes valores:

O comentário automático se adicionará aos comentários para todos os novos métodos e formulários, como também para todos os métodos e formulários existentes que se modifiquem depois de que se ativem os  comentários automáticos:

Nota: se o banco não possui um sistema de senhas, #N devolve a string “Designer.”

4D Server: os comentários automáticos podem ser modificados por qualquer máquina cliente com acesso às Propriedades do banco. Também pode modificar estes parâmetros nas Propriedades do banco na máquina servidor. Toda modificação realizada na página de comentários automáticos é considerada imediatamente em cada máquina cliente no instante em que o objeto comentado é modificado.