Сьогодні вирішив дати початок серії моїх матеріалів. При написанні різних тем мого блогу я буду керуватись своїм всланим досвідом в сфері веб-програмування, і звичайно ж своїми помилками і успіхами. Отже на мою думку я, б виділив такі правила:

Правило 1:

Як банально б це не звучало але ваш код повинен бути робочим – тобто не містити помилок. Народна приказка говорить «сім раз відмір – один раз відріж». В нашому розумінні це означає ретельно перевірити написаний код, виявити помилки, і виправити їх, прорахувати всі можливі ситуації в які користувач може потрапити після виконання задачі поставленої перед кодом.

Правило 2:

Ваш код повинен бути "читабельним". Якщо ви один, працюєте над своїми проектами, звичайно, що в більшості випадків ви зрозумієте те що було написано вами(але бувають випадки, що не завжди), але ж якщо ви працюєте в колективі, в команді розробників, ви маєте брати до уваги те що, ваш код в подальшому хтось може обслуговувати. Це не обов'язкова вимога програмування (зараз досвідченні программісти мене заплюють) але дотримуючись її, ви полегшете життя своїм, колегам, або іншим прогаммістам , щоб вони в подальшому, змогли розібратись у вашому коді, підтримувати і обслуговувати його. Зрештою "читабельний" код має досить привабливий вигляд, і ви в цьому самі переконаєтесь.

Правило 3:

Відштовхуючись від попереднього правила можна виділити наступне: залишайте коментарі  до масштабних фрагментів коду, повірте якщо вам доведеться писати багато js, або рhp бібліотек, скриптів, для власних проектів, з часом, ви можете забувати що виконує та чи інша частина коду. В цьому випадку дуже допомагає розділення фрагментів коду коментарями (максимальна задокументованість).

Правило 4:

Стосовно браузерів, і JavaScript. Намагайтесь у своїх программах досягти максимальної сумісності з різними типами і версіями баузерів (IE, Mozilla, Opera, Chrome, Safari).

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

По друге завжди передбачайте у своїх програмах крос-браузерне застосування(в основному це стосується JavaScript-програм, оскільки здебільшого вони реалізуються на стороні клієнта), відмовляйтесь від «кривих» кодів які працюють тільки в деяких браузерах і не відповідають стандартам.

Правило 5:

До першого правила, можна також додати правильне форматування. Під цим я рекомендую додавати відступи, переноси рядків, відокремлення незалежних фрагментів коду(логічне форматування). При правильному форматуванні навіть людина яка нічого не розуміє в програмуванні побачить що код виконує певні задачі, розділені між собою. При не правильному форматуванні весь код здається суцільним текстом, і стає нечитабельним навіть для самого программіста який його написав =)

Правило 6:

Розділяйте ваш код на окремі функції. Якщо деякий код в програмі зустрічається достатньо часто, доцільно буде об’єднати його в функцію. Потім ви просто можете в будь-якому місці програми викликати цю функцію не дублювавши ще раз код. У великих проектах, чи програмах потім можна використовувати написані вами функції, а не писати їх спочатку. Це зекономить ваш час – а це дуже цінна перевага. Проводьте реструктуризацію.

Але хочу додати, що перш ніж писати якусь функцію, для виконання нею поставленої задачі, слід поцікавитись чи не є ця функція вбудованою в конструкцію мови якою ви програмуєте. Це значно полегшить вашу роботу і прискорить виконання, компіляцію коду.     

Правило 7:

Давайте правильні імена функціям і змінним. Загальноприйнятим вважається давати функціям і змінним імена які починаються з маленької букви. Слід також визначити чи є мова програмування якою ви користуєтесь регістрозалежною (myWord і MYword – різні змінні чи ні ?). Якщо ви хочете дати і’мя змінній або функції, яке складатиметься з двох слів рекомендую такий синтаксис:

function my_function ()

{

}

або ж

function myFunction ()

{

}

Так само і стосовно змінних.

Правило 8:

Контроль, контроль, і ще раз контроль. Припустимо що ви дотримались усіх вище описаних правил. І випустили своє творіння, свій продукт. Але ж ми  з вами не передбачили ще однієї важливої деталі – які у нас є гарантії того, що кожен користувач буде раціонально, правильно працювати з вашою програмою ? Правильно ! Ніяких ! Ніякий програміст врешті решт  не застрахований від не правильного використання його програми, хакерських атак і т.д. Ваші програми повинні вміти виконувати перевірку на правильність отриманих даних, і не бажаних значень, а також повинен бути передбачений спосіб їх виявлення і усунення. Це збільшить вашу впевненість в правильному виконані програми, і допоможе запобігти збоям в подальшому.

Правило 9:

Збільшуйте швидкість(швидкодію) ! Перевагу якій, з двох програм, віддасть користувач, якщо вони обоє виконують поставлену задачу, але одна повільніше а друга швидше? Ви самі дали собі відповідь ! В наш час це одне з найважливіших правил, оскільки всі хочуть того, щоб програми виконувались швидко. Не нагромаджуйте свій код лишніми змінними і функціями. Ніхто не захоче працювати з «підвисаючими» програмами, де завантаження займає більше часу ніж саме виконання.

Правило 10:

Ніякого «гімнокоду». Описати гімнокод, одним терміном доволі важко. Старайтесь не «придумувати велосипед». Золоте правило програмування – не ускладнюй. Пам’ятайте код повенен бути простим і максимально зрозумілим. Старайтесь використовувати усі можливості вашої мови програмування, а не тільки її основи.

 Ось і здається все що можу порадити починаючим веб-девелоперам. На останок скажу що навіть з дотриманням усіх правил не факт, що ваш код буде правильним. Іноді такий код важко змінити, що унеможливлює його використання в нових програмах, і буде затрачений час на переписання коду на новий лад.

Раджу дотримуватись «золотої середини» між простотою коду і зниженням його читабельності(але можливо збільшенням швидкості).

Бажаю Вам успіху у всіх Ваших починаннях !