ActionScript 3.0. Правила именования.
В процессе приобретения опыта программирования, чтения чужого кода, рекомендаций по именованию, у меня выработались некоторые правила, которых я стараюсь придерживаться.
Но мне было бы интересно узнать, каких правил придерживаются другие и по каким соображениям, и, возможно, расширить набор или внести коррективы.
Сразу скажу, что признаю возможность своей неправоты и не призываю строго придерживаться правил описанных мною. Каждый предпочитает что-то своё, и что подходит одному не всегда подойдёт другому.
Базовые принципы
* Имя должно отображать суть.
* Имя должно быть легко читаемым.
* Сокращения используются только если они узнаваемы и не ухудшают читаемость.
* Имя должно быть англоязычным.
Имя класса
Здесь всё просто, правило общее для многих языков.
Набор слов, каждое начинается с прописной буквы, по сути - существительное в единственном числе с определяющими словами. Аббревиатуры пишутся прописными буквами.
Примеры
Код AS3:BigGreenSquare AngryCat XMLParser
Имя поля
Имя поля - это переменная-свойство класса или его экземпляра. Служат для хранения и управления состояниями объектов.
Код AS3:class AngryCat { private static var _manager:AngryCatManager; // поле класса private var _sex:int; // поле экземпляра }
Имя по сути - существительное в единственном или множественном числе с определяющими словами. Все буквы в имени строчные, слова отделяются друг от друга символом подчёркивания, начинается с символа подчёркивания.
Примеры
Код AS3:_x
_begin_speed
_current_target
_new_best_friends // в случае с множественным числом, это обычно Array или Vector_ready _loaded
По сути - существительное в ед. или мн. числе с определяющими словами. Все буквы строчные, слова отделяются друг от друга символом подчёркивания, начинается с буквы.
Код AS3:Примеры local_variable temp_state result args
Функции, методы, геттеры, сеттеры
Набор слов, первое начинается со строчной буквы, остальные с прописной.
Имена функций и методов по сути представляют из себя некоторый процесс, действие или вопрос, обычно начинаются с глагола.
Имена геттеров, сеттеров по сути то же что и поля
Примеры функций и методов
Код AS3:doSomething() createNewCat() isReady()
те же что и для полей, но с правилами набора букв как у функций
Код AS3:beginSpeed
currentTarget
loadedКонстанты
Набор слов, разделённых символом подчёркивания, состоящий из прописных букв. По сути ближе всего к переменным.
Примеры
Код AS3:MAX_VALUE
RADIAN_COOFИнтерфейсы
Интерфейсы в AS3 состоят из списка методов или геттеров, сеттеров. По сути служат для отображения способности что-то делать.
Имя начинается с большой буквы “I”, все остальные слова пишутся с заглавной буквы. Часто кончается на “able”, или представляет из себя абстракцию высокого уровня.
Примеры
Код AS3:IDrawable IClonable ITrajectory
Всего комментариев 59
Комментарии
25.09.2010 13:48
|
|
|
|
25.09.2010 14:22
|
|
|
DClick предлагает свои принципы именование, которые, как мне кажется, более удобны:
adobe-flex-coding-guidelines-v12-english.pdf |
|
25.09.2010 14:28
|
|
|
27.09.2010 11:44
|
|
|
Всё правильно
 |
|
27.09.2010 13:32
|
|
|
Подчеркивания в именах локальных переменных и полей — убого.
|
|
27.09.2010 14:10
|
|
|
300 раз уже обсуждалось. Используйте общепринятые ковенции, не надо своего изобретать.
Иначе при подключении внешних библиотек получится каша. Я, например, очень мучаюсь с box2D - раздражает он меня) |
|
27.09.2010 15:01
|
|
|
|
Цитата:
Иначе при подключении внешних библиотек получится каша.
С тем же Box2D |
|
27.09.2010 17:43
|
|
|
Цитата:
Подчеркивания в именах локальных переменных и полей — убого.
Ни то ни другое не является адобовским стандартом |
|
27.09.2010 19:11
|
|
|
|
По негласным стандартам "_" таки пишется перед приватными-протектедными полями. Локальные не являются таковыми, поэтому нельзя сказать что писать "_" перед локальными переменными хорошо, однако это не является достаточным условием чтобы сказать, что это плохо.
|
|
27.09.2010 20:32
|
|
|
Цитата:
это переменная-свойство
|
|
27.09.2010 20:36
|
|
|
|
Не пишу подчерк ('_') перед protected и вам не советую.
|
|
27.09.2010 20:38
|
|
|
|
Цитата:
DClick предлагает свои принципы именование, которые, как мне кажется, более удобны:
adobe-flex-coding-guidelines-v12-english.pdf |
|
28.09.2010 01:30
|
|
|
Цитата:
Пишется через тире (Alt + 0151), либо дефис обрамляйте пробелами.
|
|
28.09.2010 16:34
|
|
|
Цитата:
Не пишу подчерк ('_') перед protected и вам не советую.
|
|
28.09.2010 18:17
|
|
|
Офтоп: Да с каких пор поля стали "переменными" называть, сбивает же с толку, а то можно подумать что Вы локальные переменные с "_" пишете
|
|
29.09.2010 01:09
|
|
|
|
Поле класса может быть как изменяемым, так и не изменяемым (const и var). Соответственно, поле класса может быть переменной. Или как?
|
|
29.09.2010 13:29
|
|
|
var - variable - переменная.
С таким же успехом можно спросить: давно ли стали переменные класса называть полями? |
|
29.09.2010 14:09
|
|
|
@i.o
вы путаете тёплое с мягким. это определения разного уровня. |
|
29.09.2010 15:33
|
|
|
|
BlooDHounD, а вот и не путаю. Советую внимательнее ознакомиться с вопросом
Цитата:
Да с каких пор поля стали "переменными" называть
Цитата:
давно ли стали переменные класса называть полями?
 |
|
Обновил(-а) i.o. 29.09.2010 в 15:55
|
|
29.09.2010 16:47
|
|
|
|
i.o., ваше замечание не в тему. непонятно что вы имели виду. когда смысл слов expl донесён абсолютно чётко.
|
|
30.09.2010 00:17
|
|
|
Цитата:
Поле класса может быть как изменяемым, так и не изменяемым (const и var). Соответственно, поле класса может быть переменной. Или как?
- переменная - локальная переменная, объявленная внутри метода/анонимной функции; - поле - поле экземпляра класса (protected var item:Item, private var item:Item и т.п) - статическое поле - поле класса (private static var item:Item, ...) ИМХО называть поля переменными - все равно что называть методы функциями, зачем путаться, когда терминология уже есть. |
|
|
Обновил(-а) expl 30.09.2010 в 00:19
|
|
30.09.2010 01:45
|
|
|
|
Цитата:
все равно что называть методы функциями
Точно так же, в моем понимании, и с полями класса. По сему - не вижу в сказанном ни ошибки, ни путаницы |
|
30.09.2010 02:00
|
|
|
Возможно использование подчёркивания не очень удобно при наборе, при использовании автокомплита это неудобство нейтрализуется.
Мною был выбран такой способ именования так как он позволяет делать имена полей, переменных и геттеров-сеттеров визуально различными. Код AS3:_field_name // имя поля local_variable_name // имя локальной переменной или параметра getterName // имя метода-геттера Код AS3: |
|
30.09.2010 12:05
|
|
|
|
expl, а что, Адобовские рекомендации уже закон что ли? Если там попросят переносить открывающую фигурную скобку на пустую строку, будем переносить?
|
|
30.09.2010 12:47
|
|
|
|
Локальные переменные пишу без _
Приватные и протектедные поля пишу с _. Паблик без. Интернал использую крайне редко, не могу сказать что использую там ) Это позволяет четко видеть, что доступно за пределами класса, а что нет. protected считаю недоступным за пределом класса, несмотря на наследование и всё остальное. Вроде бы протектед с _ с флешера пишу вообще только я) Из конвенции кода следую всему, кроме парочки вещей. Одна из - это break на одном уровне с case. Мне крайне неудобно когда break идёт во вложенности case`а. ) |
|
30.09.2010 12:59
|
|
|
Цитата:
expl, а что, Адобовские рекомендации уже закон что ли? Если там попросят переносить открывающую фигурную скобку на пустую строку, будем переносить?
|
|
30.09.2010 23:03
|
|
|
Цитата:
expl, а что, Адобовские рекомендации уже закон что ли? Если там попросят переносить открывающую фигурную скобку на пустую строку, будем переносить?
Код AS3:var object:Object = { a: 10, b: 20 } Да, есть там спорные моменты, например не разделяю рекомендуемые ими неявные приведения к булеву типу (if (sprite) ...), ... да, параллель я не чёткую провел, пытаясь обломать критику "_" перед приватными полями. Да, то что пишут "this" где надо и не надо и это не являетя стандартом - не означает, что они не имеют права критиковать "_", который тоже не по стандартам перед каждым полем Но все равно, "убого" - это для вас убого, а для других - это зашибись. Цитата:
Вроде бы протектед с _ с флешера пишу вообще только я)
|
|
|
Обновил(-а) expl 30.09.2010 в 23:15
|
|
30.09.2010 23:23
|
|
|
|
Статические протектед? Звучит жутковато
|
|
30.09.2010 23:38
|
|
|
|
Цитата:
даже для статических протектед
|
|
01.10.2010 11:29
|
|
|
Цитата:
Метод является функцией. Функция может быть методом.
Точно так же, в моем понимании, и с полями класса. По сему - не вижу в сказанном ни ошибки, ни путаницы |
|
01.10.2010 14:51
|
|
|
|
Приватные статические, протектед статические. Вполне нормальная практика. Вы их не используете?
|
|
01.10.2010 21:58
|
|
|
|
Цитата:
не в этот раз. тут мы имеем случай "человек-паук", а не "человек — не паук!"
"Имя поля - это название свойства класса или его экземпляра". |
|
01.10.2010 23:51
|
|
|
|
Цитата:
Приватные статические, протектед статические. Вполне нормальная практика. Вы их не используете?
public static const, private static const - для констант private static var - для переменных где может быть оправдано использование protected static на ум не приходит |
|
01.10.2010 23:53
|
|
|
Блин, вам не надоело ? зачем всех причесывать под одну гребенку ? в 99% случаев ваш код увидите только вы сами... в остальных 1% есть правила команды...
|
|
02.10.2010 03:13
|
|
|
|
Цитата:
Блин, вам не надоело ?
|
|
02.10.2010 04:42
|
|
|
|
Цитата:
где может быть оправдано использование protected static на ум не приходит
|
|
Обновил(-а) i.o. 02.10.2010 в 06:51
|
|
02.10.2010 12:35
|
|
|
Цитата:
Блин, вам не надоело ? зачем всех причесывать под одну гребенку ? в 99% случаев ваш код увидите только вы сами... в остальных 1% есть правила команды...
|
|
02.10.2010 14:04
|
|
|
Цитата:
Это только если вы фрилансер, в противном случае в 99% процентов случаев вы услышите много мата в свой адрес от коллег
|
|
02.10.2010 15:52
|
|
|
Цитата:
не в этот раз. тут мы имеем случай "человек-паук", а не "человек — не паук!"
|
|
02.10.2010 19:53
|
|
|
|
easy.proger: в таком случае Вы навсегда останетесь тем, кому будут диктовать правила, а не кто.
f.g.programmer, самый простой пример - при изменении какой-нибудь величины, общей для всех экземпляров (например, скорость) потребуется громоздкое вычисление какой-нибудь другой величины, которую, однако, знать не потомкам не нужно - например необходимая сила, с которой нужно воздействовать на элемент для баланса системы. ZIK68, ээ... ты не в теме) |
|
02.10.2010 20:31
|
|
|
Цитата:
easy.proger: в таком случае Вы навсегда останетесь тем, кому будут диктовать правила, а не кто.
|
|
02.10.2010 21:12
|
|
|
|
Есть стандарт, есть здравый смысл. Правила нормальной команды строятся на стандарте, с минимальными поправками на здравый смысл - etc отличный пример привёл. Если не принимать стандарт, а выдумать свой - то при использовании сторонних библиотек код превратится в помойку.
|
|
02.10.2010 22:08
|
|
|
|
Psycho Tiger, хранить состояние системы объектов в статических переменных базового класса этих объектов не кажется хорошим примером.
Для данного случая, пожалуй, лучше завести некоторый класс системы, который будет управлять элементами системы. |
|
03.10.2010 11:54
|
|
|
|
Не состояние, а какую то дельту, которую по идее, можно вычислять каждый раз - но она прокэшировалась сразу и для всех.
|
|
04.10.2010 23:25
|
|
|
|
Цитата:
Сообщение от ZIK68
К сожалению перед отрицанием не ставится тире)
|
|
06.10.2010 03:05
|
|
|
На самом деле с правилами все гораздо проще. У кого кнопка "разрешить" положить в репозитори, тот правила и устанавливает
Ну не буквально конечно, но вы поняли. Я за if (foo == null) в случае, если foo - объект тупо реджектю и не волнует. |
|
06.10.2010 10:49
|
|
|
|
2wvxwv это ты что весь код смотришь? Я б повесился.)
|
|
06.10.2010 12:39
|
|
|
|
wvxvw, а что может быть null, но не является объектом? String? Вроде тоже объект. Непонятно)
|
|
06.10.2010 22:46
|
|
|
|
О, Олешка вернулся! Много багов сдал в адоб? ) А что там про ссылку-нулл забавное можно послушать?
|
|
06.10.2010 23:15
|
|
|
|
хех, я баги не сдавал... но буду, куда деться. Индекс в массиве может быть либо null либо undefined и еще много чего, что может быть false, например, но за код, в котором будут undefined я тоже выпишу, так что, можно сказать, что никогда.
Кода пока не много, больше организационные моменты напрягают, так что я лучше посмотрю в код, чем буду выяснять кому и чего делать |
Последние записи от f.g.programmer
- Simple Event Controller (05.01.2011)
- Event (16.10.2010)
- ActionScript 3.0. Правила именования. (25.09.2010)
