Кодтық стиль нұсқаулығы

PHP қауымы көбірек және байлық, көптеген кітапханалар, фреймворктар мен компоненттерден тұрады. PHP дамытуды жасаушыларының бірнеше үшін көмекшідерді таңдауы мен оларды біріктіруі орналасты. PHP кодты (жақынайағанша) әдетте популярлық кодтық стилге (code style) төмендеуі мақсатында жасауы маңызды.

Framework Interop Group ретінде мекенжай алады және мекенжай ұсынды. Бұлардың көптегені кодтық стильмен байланысатын, бірақ олардың көбі - PSR-1, PSR-12, PSR-4 мен PER Coding Style. Бұл ұсыныстар тек әдетте Drupal, Zend, Symfony, Laravel, CakePHP, phpBB, AWS SDK, FuelPHP, Lithium т.б. дайындаушы проекттерді таңдап алуда. Сіз оларды сіздік проекттеріңіз үшін пайдалана аласыз, немесе сіздік шахси стильіңізді қолдануыңыз мүмкін.

Ідеалды түрде, сіз белгілі стандартты орындайтын PHP код жазуыз. Бұл болардан PSR-лардың кездесуі немесе PEAR немесе Zend тарапынан жасалған кодтау стандарттарының кездесі жатататындылықтарының бір бірі болуы мүмкін. Бұл ешкімге бай болып, олар өз кодымен жұмыс істеу мен өтініштерде көптеген шетелді кодпен жұмыс істеген кезде таңдау үшін пайдаланылады.

Сіз PHP_CodeSniffer пайдалана алатын бірінші екі ұсыныс бойынша кодты тексеру үшін пайдалана аласыз, және Sublime Text көмекші текст редакторлар үшін плагиндерді пайдалана аласыз, өздігінен уақытты көмек алу үшін.

Сіз кодты автоматты түрде орнату үшін осы құралдарды бірін пайдалана аласыз:

Сондықтан, phpcs-ты шеңберінен тапсырып іске асырып қойуңыз:

cssCopy code

phpcs -sw --standard=PSR1 file.php

Ол, өзгертулерді көрсете отырып, оларды қалай жатқызуы туралы айту арқылы қателіктерді көрсетеді. Осылай жасалған таңдаудың стандартына сәйкес қателіктері бар бранштарды сақтауға болар, дерек көмекші қолдану осы қателіктерді түзетіп отырып кетуіне дейін жұмыс істейді.

Егер PHP_CodeSniffer бар болса, онда ол жолдамайды PHP Code Beautifier and Fixer арқылы орнатуларды туралы есептерді жоюыңыз көмекші болады.

cssCopy code

phpcbf -w --standard=PSR1 file.php

Басқа опция — PHP Coding Standards Fixer пайдалану. Ол сізге орнатулардан кейін кодтың қалыптық қателіктерін көрсетеді.

cssCopy code

php-cs-fixer fix -v --rules=@PSR1 file.php

Барлық сипаттамалар мен кодтық инфраструктура үшін ағылшын тілі таңдалады. Код базасында жұмыс істейтін барлық жазушылар мен көмекшілерге оған келетін жағдайда бір тілді пайдалануға мүмкіндік беретін комментарийлерді басқаруға мүмкіндік беретін жағдайда басқа тілде жазуы мүмкін. Соңда өте көмекші бір ресурс боларын көре аласыз: Clean Code PHP.