خواندن ۱ دقیقه·۳ سال پیش

استانداردهای کد نویسی پی اچ پی - بخش اول

PHP PSR standards - Part I - PSR-1

بهتره هر کسی که کد نویسی با php رو شروع می کنه از همون ابتدا با استانداردهای PSR آشنا بشه. این استانداردها در سایت https://www.php-fig.org گرد آوری شده اند. و در زمان تایپ این مطلب از صفر تا ۲۰ شماره گذاری شده اند. که هر شماره مبحث مربوط به خودش رو داره.

PSR-1: Basic Coding Standard

این استاندارد یعنی استاندارد شماره یک به اصول مقدماتی می پردازه که شامل موارد زیر هستش:

فایل های php فقط باید از تگ های <?php و <?= استفاده کنند.
فرمت فایل متنی استفاده شده باید حتما encoding-UTF8 باشه و بدون BOM
بخش های شامل کلاس ها و توابع و ثابت ها و ... را با بخش های اجرایی قاطی ننویسید. مثلا اگه جایی تابعی تعریف کرده اید بعد از تعریف تابع دستور echo به کار نبرید یا وسط برنامه کلاس تعریف نکنید. مثال زیر به عنوان یک کد بد در نظر بگیرید:

<?php
// side effect: change ini settings
ini_set('error_reporting', E_ALL);

// side effect: loads a file
include &quotfile.php"

// side effect: generates output
echo &quot<html>\n"

// declaration
function foo()
{
    // function body
}

مثال زیر یک فایل استاندارد است:

<?php
// declaration
function foo()
{
    // function body
}

// conditional declaration is *not* a side effect
if (! function_exists('bar')) {
    function bar()
    {
        // function body
    }
}

اسامی کلاس ها باید حتمن گویا بوده و با حروف بزرگ شروع بشه :

StudlyCaps

هر فایل باید با namespace شروع بشه.

<?php
// PHP 5.3 and later:
namespace Vendor\Model;

class Foo
{
}

ثابت ها باید با حروف بزرگ نوشته بشه
نامگذاری متغیرها به سه صورت می تونه انجام بشه:

$StudlyCaps  
$camelCase 
$under_score

متدها هم باید با حرف کوچک شروع بشه اما بقیه کلماتش حروف بزرگ باشه . مثلا:

camelCase()

phpprogrammingstandardpsr

رضا لعل

شاید از این پست‌ها خوشتان بیاید