برنامه نویسی استاندارد در PHP

هر شرکتی بسته به بهترین عملکردهایشان استاندارد های برنامه نویسی خاص خود را دنبال می کند. استانداردهای برنامه نویسی الزامی هستند زیرا برنامه نویسان زیادی با ماژول های {module} مختلفی کار می کنند و اگر هر کدام از آن ها خود شروع به ابداع استاندارد های مخصوص به خود کنند، منبع {source} بسیار بی نظم و غیر قابل کنترل می شود. همچنین ادامه استفاده و نگه داری از source code را بسیار دشوار می کند.

به دلایل زیر باید در برنامه نویسی از مشخصات، چهارچوب و دستور های مشخص پیروی کرد:

  • برنامه نویسان همکار شما باید دستور و کُدی که می نویسید را متوجه شوند.
  • استانداردهای برنامه نویسی به عنوان یک شاخص، راهنما و طرح کلی عمل می کند که تیم برنامه نویسی با کمک آن، کد ها را رمز گشایی کرده و می خواند.سادگی و روشنی که در نتیجه ی برنامه نویسی سازمان یافته و نا متناقض به دست می آید، شما و دوستانتان را از خطا های معمول و رایج باز می دارد.

چرا کدنویسی استاندارد اھمیت دارد؟

گرچه استاندارد نویسی در ابتدا مشکل است و بیھوده به نظر می رسد، اما زمانی که نرم افزارتان بزرگ شود و حجم آن به چند ھزار خط در چند صد فایل برسد، فواید آن مشخص می شود. بعضی از این فواید عبارتند از:

  • برنامه نویسان به راحتی می توانند روی کدھایی که توسط دیگران نوشته شده کار کنند. زیرا کدھا به روشی نوشته شده اند که ھر یک از برنامه نویسان با آن آشنا است.
  • اگر شخص جدیدی وارد تیم پروژه شود، به راحتی می تواند با کدھا کار کند (به شرطی که با کدنویسی استاندارد آشنایی داشته باشد.)
  • رعایت استانداردھا گاھی از ایجاد اشتباه در کدنویسی نیز جلوگیری می کند.

مشکل اصلی برای استاندارد نویسی این است که کمی زمان می برد تا به آن عادت کنید. و اگر در زمانی که در حالت تغییر از عادت ھای قدیمی به استاندارد نویسی ھستید وسواس کافی به خرج ندھید، در نھایت به مخلوطی از این دو تبدیل می شوید. برای جلوگیری از این مشکل در ابتدا باید مدام به گایدلاین ھای استاندارد نویسی مراجعه مکرر داشته باشید تا به آن عادت کنید. پس از آن شما به یک استاندارد نویس تمام عیار تبدیل خواھید شد.

جامعه برنامه نویسان و توسعه دهندگان پی اچ پی بسیار بزرگ و پراکنده است . این جامعه php  با اشتراک گذاری کتابخانه ها ، فریم ورک ها و اجزای گوناگون یک مرجع کامل برای توسعه برنامه های پی اچ پی بوجود آورده اند که دیگر توسعه دهندگان میتوانند از این ابزار ها در توسعه برنامه های خود استفاده کنند. امروزه برای اینکه بخواهید یک برنامه امن و کامل تولید کنید ، امری طبیعی است که یکی از این ابزار ها را در برنامه های خود استفاده نمایید. در حالت نیاز است که کدهای پی اچ پی برای تولید و ارائه این ابزار ها از یک سبک استاندارد پیروی کنند تا توسعه دهندگان بتوانند از کتابخانه های مختلف در پروژه های خود استفاده کنند.
گروه تعاملی فریم ورک های پی اچ پی ، مجموعه ای از سبک های استاندارد برنامه نویسی پی اچ پی را تهیه و آماده کرده اند که در برنامه های بزرگ مورد استفاده قرار داده می شوند.
این سبک ها عبارتند از:

Autoloading Standard : PSR-0
Basic Coding Standard : PSR-1
Coding Style Guide : PSR-2
Logger Interface : PSR-3
Improved Autoloading : PSR-4
HTTP Message Interfaces : PSR-7

این سبک های کد نویسی مجموعه ای از قوانین هستند که پروژه هایی نظیر Drupal، Zend، Symfony، CakePHP و دیگر پروژه های بزرگ جهان از آنها استفاده می کنند. شما میتوانید از این قوانین در پروژه های خود استفاده کرده یا به همین سبک کد نویسی در پروژه های خود را ادامه دهید. تمامی این صحبت ها بدین معنی است که شما باید بطوری کد بنویسید که از یک سبک استاندارد شناخته شده پیروی کند. این استاندارد کد نویسی میتواند یکی از PSR ها یا استاندارد های ایجاد شده Pear ، Zend یا Symfony باشد. در لینک های زیر اطلاعات بیشتری پیرامون استاندارد های کد نویسی برای این سه روش بدست آورید:

http://pear.php.net/manual/en/standards.php
http://symfony.com/doc/current/contributing/code/standards.html
http://framework.zend.com/manual/current/en/ref/coding.standard.html

شما برای بررسی هر یک از استانداردهای کد نویسی میتوانید از ابزاری مانند CodeSniffer استفاده کنید. افزونه های مختلفی برای ویرایشگر های متن وجود دارند که کار مشابهی را انجام می دهند همانند sublime-phpcs که بررسی استاندارد کدهای نوشته شده توسط ویرایشگر متن Sublimetext را بعهده دارد.

ابزار دیگری با نام PHP Coding Standards Fixer یا (php-cs-fixer.phar) وجود دارد که به صورت خودکار کد شما را نسبت به استاندارد های تعریف شده بررسی می کند و تغییرات لازم را بصورت اتوماتیک انجام می دهد بطوری که نیاز نیست شما کاری بصورت دستی انجام دهید.

دقت کنید که زبان اصلی برای ساختار کدهای پی اچ پی زبان انگلیسی است و شما در کامنت های خود میتوانید از هر زبانی که با آن آشنا هستید استفاده کنید. این به آن معناست که هیچوقت در دستورات PHP از متن های فارسی (مگر برای نمایش خروجی) استفاده نکنید.

اگر بعد از مدتی برنامه ای که نوشته اید را اصلاح کنید، فهم آن بسیار آسان می گردد.برای داشتن کیفیت هر چه بیشتر در برنامه، باید از industry standard پیروی کنید.

دستور های زیادی برای برنامه نویسی با کمک PHP وجود دارد که باید از آن ها پیروی کرد.
indenting & length line {ایجاد تو رفتگی و کنترل طول خط} – به اندازه ی ۴ جای خالی فاصله بگذارید و از هیچ tab ی استفاده نکنید، زیرا کامپیوترهای مختلف از تنظیمات مختلف برای tab استفاده می کنند. توصیه می شود که برای هرچه خوانا تر شدن کدها و دستورها، خطوط از بین ۷۵-۸۵ کاراکتر بیشتر نباشد.

control structures {ساختارهای کنترل}- شامل if، while، switch و غیره می شود. دستورهای کنترل برای تشخیص، باید حداقل یک جای خالی بین کلید واژه کنترلی و پرانتز داشته باشند. به شما توصیه می شود که همیشه از آکولاد {} استفاده کنید، حتی زمانی که استفاده از آن عملاً اختیاری است.

از دستور switch بصورت زیر می توان استفاده نمود.

 

switch (condition)

{‎

case 1:‎ ‎ action1;‎ ‎ break;‎

case 2:‎ ‎ action2;‎ ‎ break;

‎ default:‎ ‎ defaultaction;‎ ‎ break;‎ ‎

}

function calls {فراخوانی تابع}- تابع ها را باید بدون هیچ گونه فاصله یا جای خالی بین اسم تابع ها، پرانتز باز، اولین پارامتر، فاصله ی بین هر پارامتر، کاما و بدون فاصله ای بین پارامتر آخری و پرانتز بسته و سمیکالن فراخواند. مثال زیر را مشاهده کنید.

function definition {تعریف تابع}- function declaration {معرفی تابع} باید از “BSD/Allman style” پیروی کنید.

function fooFunction($arg1‎، ‏‎ $arg2 = ”)‎

‎ {‎

‎ if (condition) {‎

‎ statement;‎

‎ }‎

‎ return $val;‎

‎ }

 

comments {کامنت، نظر} – الگوی کامنت گذاری های (/* */)  و C++ (//) هر دو مناسب هستند. استفاده از الگوی کامنت گذاری  Perl/shell با (#) توصیه نمی شود.

PHP code tag- برای محصور کردن کُد PHP همیشه از <? php ?> استفاده کنید، نه از روش مختصرنویسی <? ?>. این کار برای رعایت کردن استانداردهای php {و مطابقت با آن} الزامی است. همچنین این روش آسان ترین روش برای گنجاندن کد php در سیستم عامل های مختلف است.

  • variable names
  • از حروف کوچکتر {lowercase} استفاده کنید.
  • از علامت ‘ ‘، برای جدا کردن کلمات از هم استفاده کنید.
  • global variables {متغیرهای سراسری} باید با ‘g’ پیش نویس شوند.
  • global، constant {ثابت سراسری} باید با حروف بزرگ نوشته و با این علامت ‘ ‘، از هم جدا شوند.
  • static variables {ثابت های ایستا} باید با ‘s’، پیش نویس شوند.
  • function ها را reentrant کنید – function ها نباید همیشه variable ها را static نگه دارند، که function ها را از reentrant شدن باز دارد.
  • alignment {تراز} ِ declaration block {بلوک معرفی} – بلوک های معرفی باید align و تراز شوند.
  • هر خط باید یک {statement} دستور داشته باشد – در هر خط فقط یک دستور باید وجود داشته باشد، مگر این که این دستور ها به هم بسیار نزدیک و وابسته باشند.
  • short method، functions {متدها، تابع های کوتاه}- متدها باید خودشان را فقط به یک صفحه کد محدود کنند.

نکات بسیار مهم دیگری هست که هنگام برنامه نویسی PHP باید در نظر گرفت. آنچه بسیار حائز اهمیت است ثابت قدم و سازمان یافته بودن سرتاسر فرایند برنامه نویسی است که فقط زمانی تحقق می یابد که از یک سری استاندارها در برنامه نویسی پیروی شود. اگر دوست داشتید شما می توانید استاندارهای برنامه نویسی خود را تعبیه کنید.

درباره مدیر فنی

همچنین بررسی کنید

چندین مدرسه با یک مودل

سلام شاید برای شماهم اتفاق افتاده باشه که بخاهید با یک نسخه نصبی مودل بتوانید …

دیدگاهتان را بنویسید

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *