Можно ли автоматизировать комментарии для классов, методов, конструкторов и т. Д. В Eclipse?

Question

Скажем, если я создам новый класс в Eclipse под названием "MyClass", код будет сгенерирован следующим образом:

public class MyClass
{

}

По личному соглашению, я всегда заканчиваю последнюю скобку комментарием, таким как это:

public class MyClass
{

} // end of class MyClass

---

---

• Итак, можно ли будет вставить такой комментарий для каждого класса, метода, конструктора и т.д.?
• И можно ли будет "затравить" комментарий с соответствующим названием?

... например: // end of class (class name here) 

Answer 1

На мой взгляд, это плохая практика, потому что комментарии могут быть не синхронизированы.

Тем не менее, вы можете получить тот же визуальный эффект, используя плагин Bracketeer (см. Также этот пост в блоге). Плагин автоматически отображает закрывающие комментарии по вашему желанию:

без сохранения их в исходный файл. Таким образом, "фантомные" комментарии всегда отражают текущее состояние кода, давая вам лучшее из обоих миров.

Стиль комментария настраивается.

Answer 2

Да, почти, если вы игнорируете возврат каретки.

Перейдите в Окно -> Настройки -> Java -> Стиль кода - Шаблоны кода

Это на Eclipse Indigo - в других версиях он может быть другим.

Теперь на панели «Настроить сгенерированный код ...» справа откройте ветку "Код" и выберите и измените запись "Новые файлы Java".

В диалоговом окне «Редактирование» в текстовом поле «Шаблон» вы увидите следующее:

${filecomment}
${package_declaration}

${typecomment}
${type_declaration}

который вы должны изменить к этому:

${filecomment}
${package_declaration}

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

а затем сохранить и закрыть. Попробуйте создать новый класс, и вы увидите, что он выглядит так:

package com.nomadsoft.cortex.application;

public class AdamsClass {

}
//end of AdamsClass

К сожалению, вы не можете избавиться от возврата каретки, которая помещает нужный комментарий в следующую строку. Это жестко закодировано в Eclipse.

В зависимости от того, сколько усилий вы хотите сделать, у вас есть выбор, как получить комментарий в той же строке, что и конечная скобка:

(Вариант 1) вы можете редактировать файлы шаблонов в банке JDT:

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

откройте templates/default-codetemplates.xml и найдите шаблон "newtype" в xml и замените «$ {type_declaration}» на

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

(Вариант 2) написать полный плагин для этого. Я хотел бы иметь время, чтобы сделать это. Может быть, вы делаете. Смотрите описание ссылки здесь