Комментарии Javadoc - CompareTo?

Вы уверены, что это не похоже на это?

Public int compareTo(Person per) {
    if(firstName.compareTo(per.firstName) != 0){
        return firstName.compareTo(per.firstName);
    }
    else{
        return lastName.compareTo(per.lastName);
    }

}

Этот код будет упорядочен на основе лексикографического порядка имени, если они совпадают, он затем отсортирует фамилию.

Каждый метод compareTo возвращает -1, 0 или 1 в зависимости от того, появляется ли первая строка раньше в порядке или нет.

«Лексографически» означает, что он будет отображаться после другой строки или перед другой строкой, если отсортирован по значению Unicode ее символов (с выравниванием по левому или правому краю).

Добавьте это в свой код и покажите нам результат -

System.out.println(Arrays.toString((per.firstName).getBytes())); 
System.out.println(Arrays.toString((firstName).getBytes()));

System.out.println(Arrays.toString((per.lastName).getBytes()));
System.out.println(Arrays.toString((lastName).getBytes()));

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

public int compareTo(Person per) {
    if(firstName.compareTo(per.firstName) != 0) {
        return firstName.compareTo(per.firstName);
    } else {
        return lastName.compareTo(per.lastName);
    }
}

Теперь к Javadoc, который у вас есть.

• @param указывает допустимые параметры функции. У вас есть только одно, поэтому у вас может быть только одно объявление @param.
• Поскольку этот метод возвращает значение, вам нужно иметь объявление @return.

Это изменит ваш Javadoc на это.

/**
* Method to return?
*
* @param per the person
* @return a value < 0, 0, or > 0 if...
*/
public int compareTo(Person per) {
    if(firstName.compareTo(per.firstName) != 0) {
        return firstName.compareTo(per.firstName);
    } else {
        return lastName.compareTo(per.lastName);
    }
}

В разделе после /** размещается конкретная информация о реализации; вещи, которые полезно знать тем, кто использует этот метод. Учитывая, что этот метод не проверяет, является ли любое имя или фамилия null или нет, было бы полезно указать это здесь. Остальное я оставлю в качестве упражнения для читателя.

Во-первых, ваш метод compareTo мне не кажется подходящим: - Public должен быть общедоступным.

Во-вторых, ваш метод сравнивает два объекта Person на основе лексикографически firstName или lastName, то есть в алфавитном порядке (A предшествует B или A‹B) и возвращает целочисленное значение.

Например:-

     String firstName1="B";
     String firstName2="A";
     String firstName3="B";
     String firstName4="C";

     System.out.println(firstName1.compareTo(firstName2));
     System.out.println(firstName1.compareTo(firstName3));
     System.out.println(firstName1.compareTo(firstName4));

Output: 1
 0
-1

Если firstName1 ‹ firstName3, то -1 (отрицательное целое число, первое меньше второго)
Если firstName1 › firstName2, то 1 (положительное целое число, первое больше второго)
Если firstName1 == firstName2, то 0 (ноль, оба равны)

Теперь, перейдя к вашему методу compareTo, он должен быть таким: -

     public int compareTo(Person per) {
            int i= firstName.compareTo(per.firstName);
            if(0!= i) return i;
            else
            return lastName.compareTo(per.lastName);
        }

В какой-то момент в вашей книге должно было быть объяснено, что такое Comparable есть. Сравнения в Java выполняются путем возврата целого числа (что означает меньше, больше или равно переданному значению) из метода compareTo(). Опубликованный вами метод сравнивает Person на основе их имени и фамилии. Если их фамилии совпадают, для сравнения используются их имена. В противном случае используются их фамилии.

Doe, John
Obama, Barack
Smith, John
Smith, Sally