Стандарты программирования ( как правильно оформлять код )

Все эти стандарты выполнять не обязательно, но если их

соблюдать, то последующее редактирование кода будет намного проще, и

этот код вполне смогут понять другие люди, которые будут редактировать

код.

Первый стандарт - все php файлы начинаются с <?php ( а не

сокращённого <? ), а в конце закрывающий знак ( ?> ) не

обязателен. Всё это нужно во избежания ошибок, которые могли бы быть, не

будем вдаваться в подробности, просто рассмотрим пример просто кода,

написанного по стандарту:

<?php
function hello () {
    
       return "HELLO";
    
}
echo hello ();

Как видим из этого примера - мы начали код по стандарту, и не закрыли

его, но если у Вас после php кода идут html теги ( html код ), то тогда

следует закрыть php код, иначе произойдёт ошибка.

Второй стандарт - имена файлов должны отображать смысл. Например - у нас

есть файл, в котором мы всех пользователей, тогда наш файл должен

называться - users.php

Теперь приведём пример всех файлов:

users.php

books.inc.php ( inc - для include файлов )

stat.class.php ( class - для классов )

Если таким образом создовать файлы, то в дальнейшем редактировании мы

без труда сможем определить, что это за файл.

Третий стандарт - имена переменных должны быть полными ( длинными ).

Чтобы максимально отображать суть. Принято писать маленкими буквами, и

использовать знак подчёркивания если нужно:

- $clients_table;

- $my_file_date;

Четвёртый стандарт - структуры должны открываться и закрываться на одном

уровне. Код или вложенные структуры должны смещатсья на четыре пробела

или символ TAB:

if (запись)
{
    код внутри
}
else
{
    код внутри
    код других структур
}

Также можно использовать второй, более удобный, вариант:

if (запись) {
    
    код внутри
} else {
    код внутри
    код других структур
}

Пятый стандарт - в названии функций должна использоваться "верблюжья

нотация" вместо подчёркивания, это может быть очень удобным, и немного

сократит Ваш код:

function OpenMyFile ()
{
    код ( тело ) функции
}
function getErrorMessage () {
    код ( тело ) функции
}

Шестой стандарт - в начале каждого файла или каждой функции принято

ставить комментарии /**/ :

/**
* Мой комментарий к файлу или функции
*/

Рекомендуется ставить комментарии в тексте после или перед оператором

знаками //( как вариант # )

Но почему же лучше использовать этот вариант, а не решётку #, а всё

потому, что не все редакторы понимают этот знак как комментарий, и могут

показывать ошибки, а самый распростронённый вариант - это //

Седьмой стандарт - каждое слово имени класса должно начинаться с большой

буквы, и без знака подчёркивания.

Поделиться...