Затмение комментарьего авто поколение

Question

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

Ниже приведен пример того, как выглядят эти комментарии.

class ConsLoString implements ILoString { 
    /* 
    * Methods: 
    * - String convertToString(); 
    * - String formatString(); 
    * Fields: 
    * - String first; 
    * - ILoString rest 
    * Methods on fields: 
    * - All String methods 
    * - All ILoString methods 
    */ 

    String first; 
    ILoString rest; 

    ... 

Естественно, это утомительно и излишнее вводить все эти вне для каждого класса и методы в большом файле. Есть ли способ генерировать их автоматически, в Eclipse или иначе?

Я просмотрел Eclipse, но, похоже, не существует способа перебора каждого метода/поля в классе в редакторе шаблонов Eclipse.

Любая помощь очень ценится!

Answer 1

В Eclipse перейдите в Окно -> Настройки -> Java -> Стиль кода -> Шаблоны кода С правой стороны нажмите кнопку «Стиль кода», чтобы открыть его, нажмите «Методы», а внизу проверьте флажок в которой говорится: Автоматически добавлять комментарии к новым методам и типам. Вы можете сделать то же самое и для полей.

Я не видел нигде так, как вы пытаетесь документировать классы Java. Но если это то, что вы хотите: см. this, и найдите java ClassSpy ClassMember FIELD METHOD. Вы можете напрямую взять класс ClassSpy.java из этой ссылки, скомпилировать его и выполнить класс ClassSpy.class, например: java ClassSpy ConsLoString FIELD METHOD - Он выведет поля, методы в качестве вывода. Скопируйте вывод и используйте его так, как хотите.

Answer 2

Когда вы вводите /** непосредственно перед определением класса или метода, а затем нажмите return, Eclipse генерирует некоторые (шаблонные) комментарии для классов и методов. Вы можете определить содержимое сгенерированных комментариев, перейдя в Window> Preferences> Java> Code Style> Code Templates> Comments.