Java для автоматизаторов
  • Introduction
  • Java. Введение
    • Java как язык и платформа
    • Установка и настройка
  • Язык Java. Основы
    • Hello World
    • Переменные
    • Типы данных
    • Строки
    • Циклы "while" / "do ... while"
    • Циклы "for"
    • Условный оператор "if / if ... else"
    • Условный оператор "switch"
    • Массивы
    • Задания к главе
  • ООП в Java
    • Классы и объекты
    • Методы
    • Свойства
    • Параметры методов
    • Ключевое слово this
    • Конструктор
    • Модификаторы static и final
    • StringBuffer
    • Метод toString()
    • Метод equals()
    • Наследование
    • Пакеты
    • Интерфейсы
    • Модификаторы Public, Private и Protected
    • Полиморфизм
    • Инкапсуляция
    • Использование обобщений
    • Generics and Wildcards
    • Анонимные классы
    • Исключения
    • Множественные исключения
    • Абстрактные классы
    • Вложенные классы
    • Тип Enum
    • Задания к главе
  • Коллекции
    • ArrayList
    • Linked Lists
    • HashMap
    • Sets (Множества)
    • Sorted Maps
    • Задание порядка в множестве ( natural ordering )
    • Очередь (Queue)
    • Использование итераторов
    • Создание объектов, реализующих интерфейс Iterable
    • Задания к главе
  • Стиль написания кода
    • Структура файла
    • Файлы-исходники
    • Открывающие комментарии
    • Сведения о пакете и импорте
    • Объявление классов и интерфейсов
    • Длина строки
    • Переносы строк
    • Переносы в объявлении методов
    • Переносы в операторе if
    • Переносы в тернарных операциях
    • Виды комментариев
    • Блочные комментарии
    • Однострочные комментарии
    • Комментарии в конце строки
    • Объявления (Декларации)
    • Операторы
    • Пропуски
    • Конвенция именования
    • Задания к главе
  • Работа с файлами
    • Работа с текстовыми файлами
    • Работа с XML файлами
    • Работа с JSON файлами
    • Property-файлы
    • Задания к главе
  • Log4j - система логирования сообщений в Java
    • Начало работы
    • Конфигурационные файлы
    • Стандартные аппендеры
    • Задания к главе
  • Юнит тестирование
    • JUnit vs TestNG. Основные аннотации
    • JUnit vs TestNG. Примеры тестов
      • Exception тесты
      • Ignore тесты
      • Тест с таймаутом
      • Тест сьюты
      • Параметризованные тесты
      • Зависимые тесты
      • Многопоточность
    • Asserts
    • Использование "заглушек" (Mocks)
  • Build инструменты
    • Build инструменты
    • Примеры конфигураций
  • Системы контроля версий. Git
    • Системы контроля версий. Git
    • Git. Установка
    • Git. Основы
    • Git. Основные команды
      • Настройка
      • Работа с репозиторием
      • Работа с удаленным сервером
      • Работа с ветками
Powered by GitBook
On this page
  1. Стиль написания кода

Конвенция именования

Конвенция именования делает программу более легко читаемой и понятной. Также она может давать информацию о функции идентификатора, например, указывает ли идентификатор на константу, пакет или класс, что может быть полезным в понимании кода.

Тип идентификатора

Правила именования

Примеры

Пакеты

Префикс уникального имени пакета всегда пишется в нижнем регистре латиницей и должен соответствовать одному из доменов высшего уровня, в настоящий момент это com, edu, gov, mil, net, org, или один из английских двухбуквенных кодов, обозначающих страну по стандарту ISO 3166, 1981. Последующие компоненты могут различаться в соответствии с внутренними стандартами организации. Такие стандарты могут предписывать использование названий департаментов, отделов, проектов, оборудования или логинов.

com.sun.eng com.apple.quicktime.v2 edu.cmu.cs.bovik.cheese

Классы

Имена классов должны быть существительными. В смешанном регистре первой заглавной буквой (PascalCase). Старайтесь именовать классы коротко и ясно. Используйте целые слова, избегайте сокращений (Кроме случаев, когда сокращение гораздо распространеннее, чем полная версия, как URL или HTML).

class Raster; class ImageSprite;

Интерфейсы

Имена интерфейсов пишутся так же, как и имена классов.

interface RasterDelegate; interface Storing;

Методы

Имена методов должны быть глаголами, в смешанном регистре, начиная со строчной буквы, но с использованием заглавной буквы для каждого последующего слова (camelCase).

run(); runFast(); getBackground();

Переменные

Имена переменных не должны начинаться с подчеркивания "_" или знака доллара "$", хотя технически и то и другое возможно. Имена переменных должны быть короткими, но осмысленными. Выбор имени должен быть мнемоничен - т.е. быть таким, чтобы случайный наблюдатель мог понять, для чего используется переменная. Односимвольных имен переменных лучше избегать, за исключением временных переменных. Обычные имена для временных переменных: i, j, k, m, и n для целых чисел; c, d, и e для символов.

int i; char c; float myWidth;

Константы

Имена констант должны быть написаны полностью в верхнем регистре, с разделением слов подчеркиваниями ("_").

static final int MIN_WIDTH = 4; static final int MAX_WIDTH = 999; static final int GET_THE_CPU = 1;

PreviousПропускиNextЗадания к главе

Last updated 6 years ago