Как оформлять код?

camelCase - верблюжья нотация для записи имен, состоящих из нескольких слов

camelCase — верблюжья нотация для записи имен, состоящих из нескольких слов

Оформление кода на Java похоже на С/С++. Но есть и особенности. Например, вместо подчёркиваний в многословных (last_event) идентификаторах обычно используются заглавные буквы (lastEvent — т.н. верблюжья нотация). Советую попрактиковаться в английском и почитать как это принято делать в компании Google или Oracle. Последняя инструкция довольно старенькая, но Oracle так давно существует…
Если с чтением у Вас не все хорошо, то просто внимательно рассмотрите эти картинки. Они хоть и про JavaScript, но некоторое представление об оформлении кода Вам дадут.
Если целью является разработка класса, то по крайней мере методы класса должны быть документированы в соответствии с правилами Javadoc. Достаточно будет использовать @param и @return, которые используются в примерах.

Добавить комментарий

Ваш e-mail не будет опубликован. Обязательные поля помечены *