Стиль програмування – запорука успіху програміста

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

стиль програмування – це набір правил і принципів написання коду для зручного читання і сприйняття коду програми.

Стиль програмування – запорука успіху програміста, чому? Запитайте Ви, відповідь дуже проста, тому що Вам буде набагато легше розробляти або допрацьовувати якийсь великий проект, або повертатися до доопрацювання навіть найпростіших проектів. Так як читати і розбиратися в коді, теж потрібно вміти, наприклад, Ви прийшли в організацію працювати програмістам, вести якусь програму, а весь код не зрозуміло, як і ким написаний, і щоб в ньому хоч якось розібратися, знадобиться дуже багато часу, якщо взагалі Ви в ньому зможете розібратися. Або Ви самі написали якусь програму і забули про неї, а через півроку вона Вам знадобилася, але з новими функціями, і Ви дивіться на свій власний код і не розумієте що там і як. Тому загальний стиль програмування зводиться до зручного сприйняття коду програми, тобто читабельності коду. Наприклад, побачивши код, Ви зможете відразу сказати – «Ага, ось і така-то змінна і вона мені потрібно для цього, а ось тут виклик функції і вона робить ось це».

Взагалі існує багато правил, які можна віднести до загальновизнаного стилю програмування, незалежно від самої мови програмування, і деякі з них я сьогодні торкнуся.

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

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

Тепер перейдемо безпосередньо до самих правилам.

Правила гарного стилю програмування

коментування

З назви цього правила відразу зрозуміло, що свій код потрібно коментувати. Але, відразу скажу Вам, запам’ятайте наступне:

  • занадто багато коментарів це – погано;
  • незрозумілі коментарі це – погано;
  • Чи не пояснюється суть коду коментарі – це погано.

Код необхідно коментувати там, де у програміста, який читає код, можуть виникнути питання, що для чого потрібно і чому саме так. Іншими словами, наприклад програміст, який читає код каже «а чому тут саме так написано, ось так набагато буде краще» і раптом бачить коментар, що це зроблено саме так тому що …. І, звичайно ж, відразу розуміє. У різних мовах програмування різний синтаксис, який позначає коментарі, але він досить простий всюди, наприклад:

У Visual Basic:

Private Sub Command1_Click ()
‘Оголошення змінних
Dim msg As String
MsgBox “Коментарі” ‘висновок повідомлення
End Sub

Коментарі позначаються апострофом, після якого і буде йти сам текст коментаря.

У PHP:

<? php
// перевірка отримання даних
if (isset ($ _ POST [ “name”])) {
echo ‘Всім привіт’;
}
?>

В php коментарі вже позначаються двома Слеш (//), це якщо Ви хочете закомментировать один рядок, а якщо Ви хочете закомментировать цілий шматок коду, то можна використовувати / * на початку коду, який Ви хочете закомментировать і * / в кінці.

Відступи і прогалини

Це означає, що для зручного і зрозумілого читання багато конструкцій в мовах програмування прийнято виділяти за допомогою, наприклад, табуляції або пробілу. Наприклад, в конструкціях if then else.

У Visual Basic:

Private Sub Command1_Click ()
If Text1.Text = “5” Then
MsgBox “Так само 5”
Else:
MsgBox “Не дорівнює 5”
End If
End Su

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

Перенесення коду на новий рядок

Продовжуючи тему читабельності коду, перейдемо до перенесень. Якщо у Вас рядок коду не вміщується на екрані монітора, то обов’язково переносите код на новий рядок. Наприклад, в тому ж самому Visual Basic це робиться за допомогою нижнього підкреслення:

Private Sub Command1_Click ()
If Text1.Text = “5” Then _
MsgBox “Так само 5”
End Sub

Назва змінних

У деяких організаціях прийнято якимось спеціальним чином називати змінні за допомогою префіксів і так далі, щоб було зрозуміло, що це за змінна. Ви в свою чергу можете придумати для себе свої префікси або просто називати змінні, які несуть в собі смислове навантаження, не просто називати «aaa», «bbb», «ccc» або взагалі просто однією буквою. За назвою змінної повинно бути зрозуміло для чого вона потрібна, наприклад, якщо у змінній буде зберігатися ім’я користувача, її можна назвати name і відразу все зрозуміло. Також багато програмістів використовують різний регістр в назву змінних, для наочного виділення їх, наприклад, UserName, але запам’ятайте, що регістр потрібно враховувати, коли ці змінні Ви будете використовувати.

написання функцій

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

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

Поганий стиль програмування:

<? php
if (isset ($ _ POST [ ‘n1’]) && is_numeric ($ _ POST [ ‘n1’]) &&
isset ($ _ POST [ ‘n2’]) && is_numeric ($ _ POST [ ‘n2’]) &&
isset ($ _ POST [ ‘op’]) && ! Empty ($ _ POST [ ‘op’])) {
$ N1 = $ _POST [ ‘n1’] * 1;
$ N2 = $ _POST [ ‘n2’] * 1;
$ Op = $ _POST [ ‘op’];
$ Ou = “$ n1 $ op $ n2 =”;
switch ($ op) {case ‘+’: $ ou. = $ n1 + $ n2; break;
case ‘-‘:
$ Ou. = $ N1 – $ n2; break;
case ‘*’:
$ Ou. = $ N1 * $ n2; break;
case ‘/’:
if ($ n2 == 0) {$ ou = ‘Ділення на нуль неможливо!’;} else {
$ Ou. = $ N1 / $ n2;} break;
default:
$ Ou = “Невідомий оператор ‘$ op'”;
}}?>

Хороший стиль програмування:

<? php
// Перевіряємо, чи була відправлена ​​форма
if (
isset ($ _ POST [ ‘number1’]) && is_numeric ($ _ POST [ ‘number1’]) &&
isset ($ _ POST [ ‘number2’]) && is_numeric ($ _ POST [ ‘number2’]) &&
isset ($ _ POST [ ‘operator’]) && ! Empty ($ _ POST [ ‘operator’])
) {
// фільтруємо отримані значення
$ Number1 = $ _POST [ ‘number1’] * 1;
$ Number2 = $ _POST [ ‘number2’] * 1;
$ Operator = $ _POST [ ‘operator’];
// змінна для зберігання результату
$ Output = “$ number1 $ operator $ number2 =”;
// Вибір математичного дії
switch ($ operator) {
case ‘+’:
$ Output. = $ Number1 + $ number2; break;
case ‘-‘:
$ Output. = $ Number1 – $ number2; break;
case ‘*’:
$ Output. = $ Number1 * $ number2; break;
case ‘/’:
// Поділ на нуль не можна використовувати
if ($ number2 == 0) {
$ Output = ‘Ділення на нуль неможливо!’;
} Else {
$ Output. = $ Number1 / $ number2;
}
break;
default:
$ Output = “Невідомий оператор ‘$ operator'”;
}
}
?>

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

Ссылка на основную публикацию