При именовании полей всегда необходимо использовать стиль InfixCaps. Не допускается использование символов подчеркивания для разделения слов. В имени метода всегда должна содержаться команда к действию или глагольная фраза
Правильно:
ShowStatus
DrawCircle
AddLayoutComponent
Неправильно:
MouseButton (Существительное, не описывает функцию)
drawCircle (Начинается с маленькой буквы)
add_layout_component (Используются символы подчерка)
ServerRunning (Глагольная фраза, но без команды)
Обратите внимание на последний пример (ServerRunning) - непонятно, что делает этот метод. Этот метод может использоваться для запуска сервера (лучше StartServer) или для проверки работы сервера (лучше IsServerRunning).
Методы для установки или получения значений свойств должны именоваться Get+имя свойства и - Set+имя свойства.
Например:
GetHeight, SetHeigh
Методы для теста/проверки булевских свойств класса должны именоваться с префиксом Is+имя свойства.
Например:
IsResizable, IsVisible
Для создания пар операций рекомендуется использовать следующие префиксы.
- Init / Term - инициализация и завершения модуля
- Create/Destroy - создание и удаление объекта
- Start/Stop - начало/завершение какого либо процесса
- Load/Save - загрузка/выгрузка чего либо
- Get/Set - чтение/установка чего либо...
Не допускается смешивание функций из разных пар (например Get/Save – это неправильно).
|
|
ИМЕНОВАНИЕ ПЕРЕМЕННЫХ
Имена всех локальных переменных должны подчиняться тем же правилам, которые установлены для именования полей, исключая префикс F.
Переменные, содержащие двоичные значения (флаги) могут именоваться либо с префиксом Is+имя свойства, либо с префиксом Flg+имя свойства, не рекомендуется использовать префикс "not", выражающий отрицание, всегда следует в таком случае заменять его на "Is", т.е. не использовать "NotFound", лучше "IsFound".
Рекомендуется использовать префикс "N" если переменная представляет количество чего-либо, например NItems; если переменная представляет номер, то окончание "No", например "RecordNo".