-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcode_style_guide.html
57 lines (51 loc) · 6.51 KB
/
code_style_guide.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Welcome file</title>
<link rel="stylesheet" href="https://stackedit.io/style.css" />
</head>
<body class="stackedit">
<div class="stackedit__left">
<div class="stackedit__toc">
<ul>
<li><a href="#кодтық-стиль-нұсқаулығы">Кодтық стиль нұсқаулығы</a></li>
</ul>
</div>
</div>
<div class="stackedit__right">
<div class="stackedit__html">
<h1 id="кодтық-стиль-нұсқаулығы">Кодтық стиль нұсқаулығы</h1>
<p>PHP қауымы көбірек және байлық, көптеген кітапханалар, фреймворктар мен компоненттерден тұрады. PHP дамытуды жасаушыларының бірнеше үшін көмекшідерді таңдауы мен оларды біріктіруі орналасты. PHP кодты (жақынайағанша) әдетте популярлық кодтық стилге (code style) төмендеуі мақсатында жасауы маңызды.</p>
<p><a href="https://www.php-fig.org/">Framework Interop Group</a> ретінде мекенжай алады және мекенжай ұсынды. Бұлардың көптегені кодтық стильмен байланысатын, бірақ олардың көбі - <a href="https://www.php-fig.org/psr/psr-1/">PSR-1</a>, <a href="https://www.php-fig.org/psr/psr-12/">PSR-12</a>, <a href="https://www.php-fig.org/psr/psr-4/">PSR-4</a> мен <a href="https://www.php-fig.org/per/coding-style/">PER Coding Style</a>. Бұл ұсыныстар тек әдетте Drupal, Zend, Symfony, Laravel, CakePHP, phpBB, AWS SDK, FuelPHP, Lithium т.б. дайындаушы проекттерді таңдап алуда. Сіз оларды сіздік проекттеріңіз үшін пайдалана аласыз, немесе сіздік шахси стильіңізді қолдануыңыз мүмкін.</p>
<p>Ідеалды түрде, сіз белгілі стандартты орындайтын PHP код жазуыз. Бұл болардан PSR-лардың кездесуі немесе PEAR немесе Zend тарапынан жасалған кодтау стандарттарының кездесі жатататындылықтарының бір бірі болуы мүмкін. Бұл ешкімге бай болып, олар өз кодымен жұмыс істеу мен өтініштерде көптеген шетелді кодпен жұмыс істеген кезде таңдау үшін пайдаланылады.</p>
<ul>
<li><a href="https://www.php-fig.org/psr/psr-1/">PSR-1 туралы оқу</a></li>
<li><a href="https://www.php-fig.org/psr/psr-12/">PSR-12 туралы оқу</a></li>
<li><a href="https://www.php-fig.org/psr/psr-4/">PSR-4 туралы оқу</a></li>
<li><a href="https://www.php-fig.org/per/coding-style/">PER Coding Style туралы оқу</a></li>
<li><a href="https://pear.php.net/manual/en/standards.php">PEAR Coding Standards туралы оқу</a></li>
<li><a href="https://symfony.com/doc/current/contributing/code/standards.html">Symfony Coding Standards туралы оқу</a></li>
</ul>
<p>Сіз <a href="https://github.com/squizlabs/PHP_CodeSniffer">PHP_CodeSniffer</a> пайдалана алатын бірінші екі ұсыныс бойынша кодты тексеру үшін пайдалана аласыз, және <a href="https://github.com/benmatselby/sublime-phpcs">Sublime Text</a> көмекші текст редакторлар үшін плагиндерді пайдалана аласыз, өздігінен уақытты көмек алу үшін.</p>
<p>Сіз кодты автоматты түрде орнату үшін осы құралдарды бірін пайдалана аласыз:</p>
<ul>
<li>Бірі <a href="https://cs.symfony.com/">PHP Coding Standards Fixer</a> , оның бапталған коды болдырмауы тесттерді дайындау мүмкін.</li>
<li><a href="https://github.com/squizlabs/PHP_CodeSniffer/wiki/Fixing-Errors-Automatically">PHP Code Beautifier and Fixer</a> көмекші құралы, онда кодты сіздің кодты сәйкес көру үшін пайдалана аласыз.</li>
</ul>
<p>Сондықтан, phpcs-ты шеңберінен тапсырып іске асырып қойуңыз:</p>
<p>cssCopy code</p>
<p><code>phpcs -sw --standard=PSR1 file.php</code></p>
<p>Ол, өзгертулерді көрсете отырып, оларды қалай жатқызуы туралы айту арқылы қателіктерді көрсетеді. Осылай жасалған таңдаудың стандартына сәйкес қателіктері бар бранштарды сақтауға болар, дерек көмекші қолдану осы қателіктерді түзетіп отырып кетуіне дейін жұмыс істейді.</p>
<p>Егер PHP_CodeSniffer бар болса, онда ол жолдамайды <a href="https://github.com/squizlabs/PHP_CodeSniffer/wiki/Fixing-Errors-Automatically">PHP Code Beautifier and Fixer</a> арқылы орнатуларды туралы есептерді жоюыңыз көмекші болады.</p>
<p>cssCopy code</p>
<p><code>phpcbf -w --standard=PSR1 file.php</code></p>
<p>Басқа опция — <a href="https://cs.symfony.com/">PHP Coding Standards Fixer</a> пайдалану. Ол сізге орнатулардан кейін кодтың қалыптық қателіктерін көрсетеді.</p>
<p>cssCopy code</p>
<p><code>php-cs-fixer fix -v --rules=@PSR1 file.php</code></p>
<p>Барлық сипаттамалар мен кодтық инфраструктура үшін ағылшын тілі таңдалады. Код базасында жұмыс істейтін барлық жазушылар мен көмекшілерге оған келетін жағдайда бір тілді пайдалануға мүмкіндік беретін комментарийлерді басқаруға мүмкіндік беретін жағдайда басқа тілде жазуы мүмкін. Соңда өте көмекші бір ресурс боларын көре аласыз: <a href="https://github.com/jupeter/clean-code-php">Clean Code PHP</a>.</p>
</div>
</div>
</body>
</html>