«Flex SDK coding conventions» на русском

Я уже давно подписан на RSS блога «Flash-разработка», поскольку нахожу публикуемые там материалы интересными, актуальными и, порой даже, — уникальными. Совсем недавно на этом ресурсе была опубликована серия статей под общим заголовком «Хороший стиль Flex-программирования», являющаяся русскоязычным переводом документа «Flex SDK coding conventions and best practices» — соглашения по написанию кода в классах Flex SDK. Этот документ примечателен тем, что он может помочь не одной команде разработчиков прийти к общему стилю создаваемого ими кода.

Сразу выскажу свое мнение на этот счет: код, разрабатываемый командой, обязан быть единообразным. Однако часто этому не придается должного значения. Код пишется, как уж получается, и главным является не его аккуратность, а работоспособность и быстрота написания. Говоря простыми словами, разработчики не хотят тратить время и силы на приведение кода в соответствие с соглашениями, принятыми в команде. И с одной стороны я их понимаю. Когда ты ограничен временными рамками, и осознаешь, что за короткий промежуток времени тебе еще нужно реализовать достаточно приличный объем функционала, то, конечно же, ты стремишься максимально эффективно тратить имеющееся время.

Кроме того, как действительно происходит процесс написания кода? Мне представляется, что он протекает следующим образом (по крайней мере, у меня это именно так): программист изучает задачу, понимает, какой результат необходимо получить в итоге, каким-то образом обдумывает структуру программы и приступает к непосредственному кодированию. В этот момент его мозг переходит в состояние потока, т.е. отключается от внешней среды, сосредотачивается на задаче и начинает преобразовывать мысли в компьютерный код. Это состояние не длится вечно. И пока ты в нем, ты стремишься написать по возможности наибольшую часть программы. И, конечно же, в этот момент ты уж точно не хочешь растрачивать свои силы на оформление кода.

Давайте теперь рассмотрим, почему все же стоит тратить время на приведение кода в соответствие с соглашениями, принятыми в команде. Во-первых, аккуратно и единообразно оформленный код уже внушает уважение. Совершенно таким же образом, как внушает уважение аккуратно сделанная машина или ремонт в квартире. Ты четко видишь, что другие программисты очень внимательно относятся к чистоте кода, и уже поневоле будешь стараться тоже писать достойный код.

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

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

Но вернемся к теме сегодняшней статьи. Я хотел бы сказать, что команды Flex и ActionScript разработчиков могут полностью принять соглашения по написанию кода в классах Flex SDK, предлагаемые программистами Adobe, или взять их за основу, при создании своих собственных соглашений. Тем более что сейчас этот документ полностью доступен на русском языке. Объем переведенного текста достаточно большой, и за проделанную работу я выражаю автору огромную благодарность. Ну и в качестве заключительного аккорда предлагаю ссылки на все статьи из этой серии:

• «Хороший стиль Flex-программирования. Именование»;
• «Хороший стиль Flex-программирования. Использование языка программирования»;
• «Хороший стиль Flex-программирования. Структура файла»;
• «Хороший стиль Flex-программирования. Форматирование»;
• «Хороший стиль Flex-программирования. ASDoc».

P.S.: Хотелось бы видеть все эти части собранными в один документ. =)