Code Insight
Autor: ClipaTec Informática | Publicado: 2016-09-27T17:10:00-03:00




Olá meu povo. Estamos hoje (27 de setembro de 2016) aqui para apresentar a vocês um recurso interessante, que provavelmente vocês já tenham notado ao usar alguma função no Delphi. Talvez vocês até já conhecem o recurso. Nosso objetivo hoje é mostrar como usá-lo. Afinal, de que estamos falando? Estamos falando de "Code Insight".

O Code Insight é um recurso do Delphi que permite termos uma breve histórico sobre qual a finalidade de um método, o que são cada um de seus parâmetros, retornos e observações.

Se você ainda não está entendendo do que se trata, dê uma olhadinha na imagem abaixo. Já viu essa janelinha aparecer quando se posiciona o mouse sobre um determinado método?





Isso é o code insight. Seria interessante se&nbsp;pudéssemos&nbsp;fazer isso com nossos métodos não? Facilitaria muito a compreensão, quando outro programador usar algum método que implementamos e até mesmo pra nós, visto que depois de alguns anos sem alterar uma função que nós mesmos criamos, é comum esquecermos alguns detalhes. Então este recurso seria muito útil, e a boa notícia é que é possível criarmos nossos "code&nbsp;insight", e vamos mostrar como fazê-lo.

Quando não implementamos este recurso, o Delphi mostra um padrão, que se atêm apenas aos tipos dos parâmetros e detalhes técnicos.

Em algumas versões do Delphi, simplesmente clique no menu "Tools\Options\Code Insight" que uma janela será aberta, uma espécie de winzard que vai ajudá-lo a implementar o recurso. Porém, em versões mais novas, por exemplo no XE8, não temos mais este "winzard", portanto, temos que criar na "unha".

Para isso, precisamos compreender pelo menos as principais tags utilizadas. É utilizado um padrão parecido com o usado no XML, portanto, abre-se a tag com o comando desejado e no final, fecha-se a tag. Isso é extremamente necessário para que o help&nbsp;insight habilite a janela com os comentários.

Então vamos conhecer alguns elementos XML usados, pelo menos os mais usados.




Estas tags são as mais utilizadas, porém, existem outras, que você pode conferir no Help do Delphi, basta pesquisar por&nbsp;code insight.

Uma observação importante, é que estes comentários devem ser feitos acima da declaração do método, posterior a três barras.

Muito bem, agora vamos para um exemplo prático. Crie um novo projeto no Delphi, e declare o seguinte método:





Pressione as teclas "Shift + Ctrl + C" para implementarmos o nosso método. Implemente-o da seguinte maneira:





Como vocês devem ter observado, esta é uma função muito complexa, tanto que vamos precisar criar um help para quem for utilizá-la. Só que não né? Brincadeiras a parte. É uma função bem básica, porém, eficiente para exemplificar o que queremos.

Vá até a declaração do método, e implemente os seguintes comentários, conforme mostra a imagem:





Note que foi utilizado as três barras antes de cada comando, e no final, as tags estão sendo fechadas. Se esquecer de fechar uma se quer, o recurso não vai funcionar, sendo assim, caso você for testar e não funcionar, pode voltar aos comentários que provavelmente você esqueceu de fechar alguma tag ou escreveu um comando errado.

Agora vejamos o recurso funcionando na prática, ao posicionar o cursor do mouse sobre a chamada do nosso método, repare que agora a janela do code insight não é a padrão do Delphi e sim a nossa que criamos.





Aqui finalizamos mais este artigo, use e abuse, até o próximo. Grande abraço.


(ClipaTec Informática)