Comentários Automáticos no Eclipse
Comentários são indispensáveis na programação. Entre outros fatores, um bom comentário ajuda não só o próprio desenvolvedor a entender o código, quanto qualquer outra pessoa que possa vir a trabalhar no desenvolvimento da aplicação.
Comentar o código pode causar uma certa sensação de improdutividade. Por isso, hoje ensinarei como personalizar os comentários automáticos do Eclipse para que, com isso, ganhemos produtividade no desenvolvimento.
Primeiramente, gostaria de dizer que TUDO que é gerado automaticamente pelo Eclipse pode ser personalizado mas, como o foco desse post é nos comentários, irei me deter a eles.
Primeiramente, no Eclipse, vá em Window > Preferences
Na janela “Preferences”, vá em Java > Code Style > Code Templates
Vou pegar como exemplo o comentário da Classe, que é aquele que colocamos no início de nossa Classe. Se quiser ver o conceito de comentários pode encontrar em meu outro post: Boas Práticas em Java – Guia Definitivo.
Vá em Comments > Types
Clique em “Edit…”
Para alterar, existem algumas “Variáveis” que podemos usar.
- ${user} – Quando o comentário for gerado, irá recuperar o nome do usuário logado no Sistema Operacional;
- ${date} – Recupera a data em que o comentário foi gerado;
- ${file_name} – Recupera o nome do arquivo;
- ${time} – Recupera a hora em que o comentário foi gerado;
- ${todo} – Coloca uma tag TODO;
- ${year} – Recupera o ano em que o comentário foi gerado;
- Entre outras muitas outras que cada tipo de comentário possui;
Vejamos um exemplo.
E o código foi gerado assim:
/** * SomaServico * * @author Administrador * @date 15/02/2012 * @version 1.0 */
Se observar, embaixo existe uma caixa onde pode marcar.
Se estiver marcada, toda vez que criar um método, classe, atributo, o comentário será automaticamente colocado.
Agora é questão da imaginação de cada um. Analisem onde e como podem aumentar a produtividade para se adequar ao padrão que usam.
Até a próxima!
Ótima dica, não conhecia esse recurso.
Vou começar a utilizar.