Основные правила написания ActionScript кода

На этом уроке ActionScript мы рассмотрим 6 коротких вопросов:

1. Планируйте и организуйте свой ActionScript код
2. Будьте последовательны
3. Сразу закрывайте скобки
4. Добавляйте пробелы
5. Добавляйте комментарии в Ваш код
6. Используйте образные имена

Несмотря на то, что плохо написанный, неорганизованный, нечитабельный ActionScript код будет правильно работать Вы все таки должны следовать правилам его написания, которые программисты вырабатывали десятилетиями и которые в итоге обеспечивают более продуктивную работу: последующие изменения в коде Вам будет делать проще, проверка на ошибки проводиться легче, сотрудничество с другими программистами пройдет без проблем.

Планируйте и организуйте свой ActionScript код

Если Вы спланируете заранее порядок работы над скриптом, приступая к его написанию, то это гарантированно поможет Вам сэкономить массу времени в работе, а в итоге получить именно то, что и было задумано. Поэтому прежде всего подумайте о том, какие задачи должен решить Ваш Actionscript код и о путях достижения этой цели.

Правильно организуйте ваш скрипт. Сгруппируйте все переменные ActionScript в самом начале скрипта для более легкого поиска в дальнейшем. Сгруппируйте другие, сходные блоки кода вместе: функции ActionScript с функциями, события с событиями и т.д. Все это создаст определенный порядок, при котором скрипт будет легко читаться. Если Вы хотите присвоить какому-либо объекту Actionscript 3 серию свойств, то делайте это в одном месте, а не разбрасывайте эти записи по телу всего скрипта – собирите их в один блок. Чем лучше будут организованы Ваши записи, тем легче Вам будет работать с ActionScript кодом.

Будьте последовательны

Как уже отмечалось ранее ActionScript чувствителен к регистру букв (строчные или прописные). Если Вы решите использовать «горбатый стиль» для написания имен переменных (var), то следуйте ему на протяжении всего кода. Изменение в стиле повлечет за собой ошибку. Например:

var myPensColors:int = 24;
var mypenscolors:int = 24;

являются различными переменными, хотя и звучат одинаково. Помните – это в итоге сильно сократит у Вас количество невынужденных ошибок в ActionScript коде.

Тоже самое относится и к другим стилям. К примеру, если Вы записываете имя переменной для имени клиента как fname, а для его фамилии – lastname, то это будет стилистической ошибкой. Хотя код будет работать правильно, но подобный подход внесет путаницу в общий стиль записей. Решением будет – lname. Т.е. Вы используете только первую букву первого слова в составном имени переменной. Итак, Вы либо записываете fname и lname, либо firstname и lastname. Если Вы решите использовать нижнее подчеркивание для отделения слов в имени переменной (var), то делайте это так: first_name и last_name.

Сразу закрывайте скобки

Блоки Actionscript кода, такие как функции или условные выражения требуют использования фигурных скобок для отделения от остального кода. Поэтому когда Вы будете их записывать ставьте сразу открывающую скобку и закрывающую. Другими словами, сначала напишите каркас функции, а затем уже наполняйте её необходимым кодом.

function myFunc(){
}

Следуя этому правилу Вы никогда не забудете поставить закрывающую скобку в конце, что исключит ошибки в дальнейшем.

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

Добавляйте пробелы

ActionScript не чувствителен к пробелам (spacebar), поэтому Вы можете значительно улучшить читабельность Вашего ActionScript кода, добавляя там где нужно пробелы. Давайте рассмотрим следующий пример:

var color:String = "красный";
var item:String = "карандаш";
function phrase(first_word:String,last_word:String):String
{return color + " " + item;}

Теперь сравните его со следующей записью:

var color:String = "красный";
var item:String = "карандаш";
function phrase( first_word:String, last_word:String ):String
{
   return color + " " + item;
}

Результат обработки обоих блоков кода будет идентичным, но чтение второго блока будет гораздо более легким, а следовательно и работа проще.

Добавляйте комментарии в Ваш ActionScript код

Комментарии к тем или иным блокам кода значительно упростят работу с ним как для Вас, так и для других программистов, если таковым придется когда-либо его редактировать. Поэтому, если с первого взгляда нельзя понять, что делает данная строка или блок кода, то обязательно прокомментируйте это.

Используйте образные имена

Всегда используйте образные имена для переменных, постоянных, массивов ActionScript, функций и т.д. Например, гораздо более понятным будет содержание переменной если Вы назовете её myBooks, нежели просто x. Такие образные или описательные имена гораздо легче запомнить и в целом код станет более понятным. Определенно, в переменной myBooks хранится что-то, связанное с книгами, тогда как имя x вообще ни о чем не говорит.

Называя функции Вы должны использовать следующее соглашение: глагол+существительное. Подобный подход позволяет сразу легко понять что делает конкретная функция. Например:

function concatWords(){
}

concat – соединять, связывать; Words – слова. Получаем: соединить слова, т.е. в итоге предполагается создание фразы или предложения. Таким образом, работа функции ясна даже без каких-либо комментариев в ActionScript коде.