ActionScript 3.0. Правила именования.
В процессе приобретения опыта программирования, чтения чужого кода, рекомендаций по именованию, у меня выработались некоторые правила, которых я стараюсь придерживаться.
Но мне было бы интересно узнать, каких правил придерживаются другие и по каким соображениям, и, возможно, расширить набор или внести коррективы.
Сразу скажу, что признаю возможность своей неправоты и не призываю строго придерживаться правил описанных мною. Каждый предпочитает что-то своё, и что подходит одному не всегда подойдёт другому.
Базовые принципы
* Имя должно отображать суть.
* Имя должно быть легко читаемым.
* Сокращения используются только если они узнаваемы и не ухудшают читаемость.
* Имя должно быть англоязычным.
Имя класса
Здесь всё просто, правило общее для многих языков.
Набор слов, каждое начинается с прописной буквы, по сути - существительное в единственном числе с определяющими словами. Аббревиатуры пишутся прописными буквами.
Примеры
Имя поля
Имя поля - это переменная-свойство класса или его экземпляра. Служат для хранения и управления состояниями объектов.
class AngryCat { private static var _manager:AngryCatManager; // поле класса private var _sex:int; // поле экземпляра }
Имя по сути - существительное в единственном или множественном числе с определяющими словами. Все буквы в имени строчные, слова отделяются друг от друга символом подчёркивания, начинается с символа подчёркивания.
Примеры
_x
_begin_speed
_current_target
_new_best_friends // в случае с множественным числом, это обычно Array или Vector
Локальные переменные и параметры методов
По сути - существительное в ед. или мн. числе с определяющими словами. Все буквы строчные, слова отделяются друг от друга символом подчёркивания, начинается с буквы.
Функции, методы, геттеры, сеттеры
Набор слов, первое начинается со строчной буквы, остальные с прописной.
Имена функций и методов по сути представляют из себя некоторый процесс, действие или вопрос, обычно начинаются с глагола.
Имена геттеров, сеттеров по сути то же что и поля
Примеры функций и методов
Примеры геттеров, сеттеров
те же что и для полей, но с правилами набора букв как у функций
Константы
Набор слов, разделённых символом подчёркивания, состоящий из прописных букв. По сути ближе всего к переменным.
Примеры
Интерфейсы
Интерфейсы в AS3 состоят из списка методов или геттеров, сеттеров. По сути служат для отображения способности что-то делать.
Имя начинается с большой буквы “I”, все остальные слова пишутся с заглавной буквы. Часто кончается на “able”, или представляет из себя абстракцию высокого уровня.
Примеры
Всего комментариев 59
Комментарии
06.10.2010 23:52 | |
Ну так в примере, в условии, явно спрашивали за null, заметь, а не за undefined. Или я опять что-то не понял, или что-то ты утаиваешь? )
|
07.10.2010 00:26 | |
А, понятно! Это ты про нубские ошибки. Я просто подумал, что это честный человек написал в условии того, чего хочет.)
|
07.10.2010 13:48 | |
Мне всегда было интересно, кто как пишет названия, если они содержат аббревиатуры и тп вещи, типа XML, ID, HTTP и т.п?
myID или myId, XMLParser или XmlParser? |
07.10.2010 18:08 | |
xmlParser или XMLParser. Ссылки на конвенции были.
Олег, а ты устроился LD работать? Расскажи =) |
08.10.2010 08:35 | |
Цитата:
Ссылки на конвенции были.
|
Последние записи от f.g.programmer
- Simple Event Controller (05.01.2011)
- Event (16.10.2010)
- ActionScript 3.0. Правила именования. (25.09.2010)