Менее известные Handy Eclipse IDE плагины

Люди могут предпочесть других (Netbeans, InteliJ Idea, …), но для меня это была предпочтительная среда разработки в течение нескольких лет. Суть этого поста не в том, чтобы делать какие-либо сравнения с другими, однако.

Основной технологией, используемой в Eclipse, является OSGI, что делает его легко расширяемым. Существует множество плагинов, некоторые из них хорошо известны, однако, возможно, есть такие, о которых вы никогда не слышали, но могут найти их полезными, как только вы увидите их в действии.

Я решил, что пришло время для первой мини-серии в моих сообщениях в блоге.

Давайте начнем с плагина, который я нашел уже довольно давно … (спасибо моему бывшему коллеге)

JAutoDoc ( http://jautodoc.sourceforge.net/ )

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

Я видел / читал различные мнения о комментариях к коду. Кое-где доходят до крайностей, но я в основном согласен с тем, что все API должны иметь комментарии. В мире Java это означает, что JavaDocs для классов / методов / полей / … должна присутствовать.

Конечно, если дизайн класса хороший объектно-ориентированный и понятный, другим будет легче понять его, а программисту написать JavaDocs для него.

Но если вы попытаетесь достичь 100% документированного API, могут быть поля или методы, имена которых достаточно наглядны, чтобы их функциональность / идея была понятна только по имени. Для подобных случаев может быть полезно иметь автоматизированное решение. Более того, если вы недовольны автоматически сгенерированными Javadocs в Eclipse, но все же хотели бы использовать генерацию для основных комментариев, вручную предоставляя только поля / метод / … особенности, я рекомендую попробовать JAutoDoc.

Установка

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

http://jautodoc.sourceforge.net/update/

Тестовый пример

После завершения установки я перезапустил eclipse и создал образец проекта Java.

Предположим, у нас есть такой класс:

public class Person {
 private String firstName;
 private String middleName;
 private String surname;
}

Смысл всех полей более-менее понятен. Давайте посмотрим, что JAutoDoc может сделать для нас, и сравним это с комментариями, сгенерированными по умолчанию.

Горячие клавиши

Но сначала, поскольку я большой поклонник сочетаний клавиш, давайте перечислим соответствующие. По умолчанию для создания комментариев на конкретный элемент:

• Затмение одно: Alt + Shift + J
• JAutoDoc один: Alt + Ctrl + J

Это хорошо, потому что мы можем выбрать тот, который нам нравится, в зависимости от ситуации.

И … действие

Eclipse генерирует JavaDocs :

/**
 * @author 
 *
 */
public class Person {
 /**
  * 
  */
 private String firstName;
 /**
  * 
  */
 private String middleName;
 /**
  * 
  */
 private String surname;

JAutoDoc генерирует JavaDocs :

// TODO: Auto-generated Javadoc
/**
 * The Class Person.
 */
public class Person {
 
 /** The first name. */
 private String firstName;
 
 /** The middle name. */
 private String middleName;
 
 /** The surname. */
 private String surname;
 
}

Что ж, я бы сказал, что это может ускорить процесс, и в этом случае комментарии выглядят хорошо без необходимости последующего редактирования.

Чтобы сделать нашу жизнь еще проще, JAutoDocs позволяет нам генерировать комментарии ко всем выбранным элементам, поэтому, если вы не хотите просматривать каждое поле и генерировать его отдельно, просто выберите все в редакторе и нажмите сочетание клавиш. 

Случай геттеров / сеттеров

Давайте проверим, как выглядят комментарии к получателям / установщикам.

В Затмении:

• щелкните правой кнопкой мыши и выберите Source -> Generate get and setters 
• после этого выбор всех полей и проверка комментариев метода Generate оставляет нам содержимое

/**
 * @author 
 *
 */
public class Person {
 /**
  * 
  */
 private String firstName;
 /**
  * 
  */
 private String middleName;
 /**
  * 
  */
 private String surname;

 /**
  * @return the firstName
  */
 public String getFirstName() {
  return firstName;
 }
 /**
  * @param firstName the firstName to set
  */
 public void setFirstName(String firstName) {
  this.firstName = firstName;
 }
 /**
  * @return the middleName
  */
 public String getMiddleName() {
  return middleName;
 }
 /**
  * @param middleName the middleName to set
  */
 public void setMiddleName(String middleName) {
  this.middleName = middleName;
 }
 /**
  * @return the surname
  */
 public String getSurname() {
  return surname;
 }
 /**
  * @param surname the surname to set
  */
 public void setSurname(String surname) {
  this.surname = surname;
 }
}

Теперь давайте посмотрим, как будут выглядеть комментарии при генерации JAutoDoc:

// TODO: Auto-generated Javadoc
/**
 * The Class Person.
 */
public class Person {
 
 /** The first name. */
 private String firstName;
 
 /** The middle name. */
 private String middleName;
 
 /** The surname. */
 private String surname;

 /**
  * Gets the first name.
  *
  * @return the first name
  */
 public String getFirstName() {
  return firstName;
 }
 
 /**
  * Sets the first name.
  *
  * @param firstName the new first name
  */
 public void setFirstName(String firstName) {
  this.firstName = firstName;
 }
 
 /**
  * Gets the middle name.
  *
  * @return the middle name
  */
 public String getMiddleName() {
  return middleName;
 }
 
 /**
  * Sets the middle name.
  *
  * @param middleName the new middle name
  */
 public void setMiddleName(String middleName) {
  this.middleName = middleName;
 }
 
 /**
  * Gets the surname.
  *
  * @return the surname
  */
 public String getSurname() {
  return surname;
 }
 
 /**
  * Sets the surname.
  *
  * @param surname the new surname
  */
 public void setSurname(String surname) {
  this.surname = surname;
 }
}

Хорошо, это намного лучше, я бы сказал.

До сих пор мы только царапали поверхность примерами. Но, как вы можете видеть, я парень, достаточно ленивый, чтобы автоматически генерировать вещи. Так что вы не можете ожидать, что я подумаю о более сложном примере.

В любом случае, если вы заинтересованы в более реальных сценариях, возможно, в вашем проекте, нет ничего лучше, чем попробовать и принять решение.

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

Больше информации

Если интересно, полный список функций можно найти на официальном веб-сайте:
http://jautodoc.sourceforge.net/index.html.

Чтобы иметь представление, доступны следующие варианты плагинов:

Я с нетерпением жду следующего поста в серии. Не стесняйтесь предлагать плагины, которые вы найдете полезными в вашей повседневной работе (в противном случае я буду придерживаться только моего списка предпочтений).

Это сообщение из
блога pb .