Optymalna długość nazwy zmiennej Java z punktu widzenia czytelności - Java, zmienne, czytelność kodu

Rozważ stałą w następującym fragmencie kodu Java:

public class ConsumerServiceTestFixture {
private ConsumerServiceTestFixture() {
throw new AssertionError("This class should not be instantiated");
}

public static final String CUSTOMER_ID_NOT_INTEGER = "12345678901";
}

Stała CUSTOMER_ID_NOT_INTEGER powyżej służy do przechowywania ciągu, którego nie można przekonwertować na liczbę całkowitą, ponieważ jego wartość jest większa niż liczba całkowita.MAX_VALUE.

Nie wynika to z nazwy zmiennej, która przekazuje co najwyżej, że wartość jest „nieprawidłowym” identyfikatorem klienta. Nic nie jest przekazywane czemu wartość jest nieprawidłowa.

Jedną z opcji byłoby napisanie komentarza, który mówi coś takiego:

// Invalid since this number is greater than Integer.MAX_VALUE
public static final String CUSTOMER_ID_NOT_INTEGER = "12345678901";

Gdybyśmy jednak musieli napisać samodokumentujący kod i nie używać komentarzy, jedyną inną opcją byłoby uczynienie nazwy zmiennej bardziej opisową. Coś jak :

public static final String CUSTOMER_ID_GREATER_THAN_INTEGER_MAX_VALUE = "12345678901";

Jednak dzięki powyższej opcji nie jestem zadowolony z długości nazwy zmiennej, zwłaszcza jeśli weźmiesz pod uwagę następujący fragment o optymalnej długości nazwy zmiennej z Code Complete 2:

Jak zasugerowałbyś, aby zrównoważyć długość nazwy zmiennej względem czytelności kodu?

Odpowiedzi:

Jeśli zamiast // komentarza użyjesz komentarza / **(to znaczy javadoc), gdy programista użyje stałej z IDE lub spojrzy na javadoc, otrzyma pełne wyjaśnienie wszystkich zalet i wad takiego projektu, dlaczego zostało to zrobione w ten sposób itp.

Niestety nie można nazwać go „CUSTOMER_ID_THAT_IS_A_STRING_BECAUSE_IF_IT_WAS_AN_INT_IT_WOULD_BE_TOO_LARGE”.