Eclipse Object Info Box на пользовательских объектах - PullRequest
Новая
       37

Eclipse Object Info Box на пользовательских объектах

0 голосов
/ 18 декабря 2018

Я не мог найти, как сделать это где-нибудь еще в Интернете, хотя я уверен, что это действительно легко сделать.Хотя я в основном самоучка, и я хотел бы начать учиться правильно документировать свой код.Это «желтое поле», которое выскакивает в затмении с информацией о методе - я хочу, чтобы оно всплыло на пользовательском объекте.Для моего примера ниже у меня есть пользовательский класс с именем «Системные свойства» и метод с именем «getOs», но когда я наведите курсор на эту опцию, информация не появится. Как добавить информацию к моему объекту?

На этом рисунке показано желтое поле enter image description here

На этом рисунке показано отсутствие символа "Желтое поле "на моем объекте enter image description here

и, наконец, код моих пользовательских объектов ... 

public class SystemProperties {

    private String os;

    public SystemProperties() {
        this.os = setOs();
    }

    private String setOs() {
        String osName = System.getProperty("os.name");
        if(osName.toLowerCase().contains("window"))
            return "Windows";
        else if(osName.toLowerCase().contains("mac"))
            return "Mac";
        else
            return "Linux";

    }

    /**
     * Method to grab the OS the user is running from
     * @return String - the os
     */
    public String getOs() {
        return this.os;
    }

}

Заранее благодарим вас за ваше время и знания.:)

РЕДАКТИРОВАТЬ: Когда я импортирую проект пользовательского объекта, он работает просто отлично.Это не работает, только когда я экспортирую проект пользовательского класса в файл jar, а затем использую его.Нужно ли нажимать опцию на экране экспорта?

1 Ответ

0 голосов
/ 18 декабря 2018

Eclipse берет информацию из примечаний над методами во встроенных объектах.

см. Это: 

    /**
 * Returns <tt>true</tt> if this map contains a mapping for the specified
 * key.  More formally, returns <tt>true</tt> if and only if
 * this map contains a mapping for a key <tt>k</tt> such that
 * <tt>(key==null ? k==null : key.equals(k))</tt>.  (There can be
 * at most one such mapping.)
 *
 * @param key key whose presence in this map is to be tested
 * @return <tt>true</tt> if this map contains a mapping for the specified
 *         key
 * @throws ClassCastException if the key is of an inappropriate type for
 *         this map
 * (<a href="{@docRoot}/java/util/Collection.html#optional-restrictions">optional</a>)
 * @throws NullPointerException if the specified key is null and this map
 *         does not permit null keys
 * (<a href="{@docRoot}/java/util/Collection.html#optional-restrictions">optional</a>)
 */
 boolean containsKey(Object key);

Вы можете сделать то же самое с методами ваших собственных объектов.

...