metala's blog

Нека започна с това, че това са моите виждания за добре подреден код и не сте длъжни да ги спазвате. Вие сте програмистите и вие решавате какво да правите.

Като за начало да запозная с основни термини:

Шльокавица – това е, когато нещо на български е изписано с латински букви. На пример – 6lyokavitza..
PascalCase – начин на изписване, когато думите са слепени и всяка дума започва с голяма буква.
camelCase – като PascalCase, само че първата дума започва с малка буква.

Основа:
Писането на “шльокавица”, е недопустимо.
Коментарите може да са на бългаски с кирилица или английски с латиница.
Всичко останало е по-прилежно да е на английски, защото повечето термини, техники и неща в ИТ произлизат от английски език и притежават по-голяма конкретност, а и са придобили по-голяма популярност.

Променливи:
Променливите и параметрите на функции трябва да бъдат в camelCase:
$firstVariable, $secondVariable
Параметрите на функции, ако са параметри променливи (т.е. се предават с референция) са предхождани от малка буква “r” (reference):
&$rReferencedVariable

Абревиатури:
Когато абревиятурата е с повече от две букви (HTML), то в camelCase, тя се изписва с първа главна и останалите млаки букви.
$asyncHttpRequest
За сметка на това, другите съкращения, като UI, OS си запазват форматирането.

Класове:
Прието е наименуванията на класовете да бъде в PascalCase, членовете на обекта/класа се изписват както променливите, изключение се прави когато има полиморфизъм на членовете на обекта и с цел да няма сблъсъци, тогава се слага “m” (member) пред члена (public $mProperty;).
Наименуванията на методите и свойствата следват camelCase.
Ако свойството или метода има достъп protected или private, тогава се слага “_” (долна черта) преди името. При членове започващи с “m”, може да отпадне.

class HtmlGenerator
{
    public $elements = array('div');
    protected $_hidden = 'hidden';

    public function generateHtml()
    {
        ...
    }
    protected function _parseHtml($html)
    {
        ...
    }
}

[ В процес на дописване и доизясняване на стила на писане ]