É possível automatizar comentários para classes, métodos, construtores, etc. no Eclipse?

Question

Digamos que se eu criar uma nova classe no Eclipse chamada "MyClass", o código será gerado da seguinte forma:

public class MyClass
{

}

Por convenção pessoal, eu sempre termino o último escalão com um comentário como este:

public class MyClass
{

} // end of class MyClass

• Então, seria possível inserir tal comentário para cada classe, método, construtor, etc.?
• E seria possível "semear" o comentário com o nome relevante?

... como : // end of class (class name here)

    

Answer 1

Sim, quase, se você desconsiderar um retorno de carro.

Ir para a janela - > Preferências - > Java - > Estilo de código - Modelos de código

Isso está no Eclipse Indigo - pode ser diferente em outras versões.

Agora, no painel "Configurar código gerado ..." à direita, abra a ramificação "Código" e selecione e edite a entrada "Novos arquivos Java".

Na caixa de diálogo Editar, na caixa de texto Padrão, você vê o seguinte:

${filecomment}
${package_declaration}

${typecomment}
${type_declaration}

que você precisa modificar para isso:

${filecomment}
${package_declaration}

${typecomment}
${type_declaration}//end of ${type_name}

e, em seguida, salve e feche. Tente criar uma nova turma e verá que é assim:

package com.nomadsoft.cortex.application;

public class AdamsClass {

}
//end of AdamsClass

Infelizmente, você não pode se livrar do retorno de carro que coloca o comentário desejado na próxima linha. É codificado dentro do Eclipse.

Dependendo de quanto esforço você deseja ir, você pode escolher como colocar o comentário na mesma linha que o colchete de fechamento:

(Opção 1) você pode editar os arquivos de modelo no jar do JDT:

eclipse\plugins\org.eclipse.jdt.ui_*.jar

abra modelos / default-codetemplates.xml e encontre o modelo "newtype" no xml, e substitua o "$ {type_declaration}" por

public class ${type_name} \{
\} // end of ${type_name}

(Opção 2) escreva um plugin completo para fazer isso. Eu adoraria ter tempo para fazer isso. Talvez você faça. Consulte insira a descrição do link aqui

    

Answer 2

Na minha opinião, esta é uma prática ruim, porque os comentários podem ficar fora de sincronia.

No entanto, , você pode obter o mesmo efeito visual usando o plug-in Bracketeer (veja também esta postagem no blog ). O plugin exibe automaticamente os comentários de fechamento, como você deseja:

semsalvá-losnoarquivodeorigem.Assim,oscomentários"fantasmas" sempre refletem o estado atual do código, dando a você o melhor dos dois mundos.

O estilo de comentário é configurável .