استانداردهای کدنویسی در وردپرس » استانداردهای کدنویسی در وردپرس

استانداردهای کدنویسی در وردپرس

thumb-50-codding-standards

وردپرس استانداردهای خاصی برای کدنویسی فناوری‌های مختلف تحت وب دارد. اگر برنامه‌نویس حرفه‌ای بوده باشید، حتما اهمیت و ارزش رعایت استاندارد را می‌دانید.

رعایت استاندارد موجب می‌شود که توسعه نرم‌افزار و عیب‌یابی آن راحتتر و کدتان خواناتر شود. رعایت استانداردهای کدنویسی در وردپرس به شدت توصیه می‌شود.

استانداردهای کدنویسی PHP در وردپرس

 برای کدتان داکیومنت بنویسید

یکی از مهم‌ترین و واضح‌ترین نکات در توسعه نرم‌افزار، تهیه داکیومنت است. کامنت‌گذاری راحت‌ترین راه برای ایجاد داکیومنت است. در حین نوشتن کد برنامه، در مورد نحوه عملکرد الگوریتم، ورودی و خروجی توابع، نقش و کارکرد کلاس‌ها و دلیل تعریف متغیرها کامنت‌گذاری کنید.

اگر هیچ کامنتی نگذارید، وقتی پس از چند ماه به سراغ کدتان بیایید، هیچ چیزی از آن متوجه نخواهید شد. باید زمان زیادی برای فهم کد خودتان صرف کنید. مخصوصاً اگر برنامه پیچیده بوده باشد.

نحوه نوشتن کامنت PHP در وردپرس، فرمت خاصی دارد که به PHPDoc معروف است. تمام کدهای وردپرس به همین صورت کامنت‌گذاری شده‌اند. در زیر یک تکه از فرمت PHPDoc آورده شده است:

< ?php

/**

* Short description

*

* Longer more detailed description

*

* @param type $varname1 Description

* @param type $varname2 Description

* @return type Description

*/

function super_function( $varname1, $varname2 ) {

//do function stuff
}
? >

 با یک نگاه می‌توان نحوه عملکرد تابع و ورودی و خروجی‌های آن را متوجه شد. این نوع کامنت در IDE های پیشرفته بصورت خودکار نمایش داده می‌شود.

نامگذاری متغیرها، توابع و فایل‌ها

نام متغیرها و توابع باید با حروف کوچک نوشته شوند. طبق استاندارد وردپرس، برای جداسازی کلمات باید از underline استفاده شود. از camelCase و خلاصه‌سازی هم استفاده نکنید. بدین صورت نام توابع معرف کارکردشان است. همانند مثال زیر:

 [/addcode]

< ?php

function myplugin_function_name ( $speed = ‘slow’) {

//do something
}
? >

اسم فایل‌ها هم باید با حروف کوچک باشد؛ فقط در اسم فایل به جای Underline از خط تیره استفاده می‌شود.

همانند مثال بالا، اگر می‌خواهید برای متغیر ورودی تابع مقدار پیش‌فرض تعیین کنید، مقدار به صورتی با معنی باشد.

تک کوتیشن و دابل کوتیشن

در زبان PHP برای تعریف رشته هم از دابل کوتیشن می‌توان استفاده کرد و هم تک کوتیشن. در وردپرس استفاده از تک کوتیشن توصیه می‌شود. زیرا وقتی می‌خواهید تگ‌های HTML را در رشته بیاورید، دیگر نیازی به بک اسلش پشت علامت رشته نیست.

< ?php

echo ‘ < a href=”http://example.com/” > Visit Example.com < /a > ’;
? >

البته وقتی می‌خواهید در رشته یک متغیر به کار ببرید، حتما باید از دابل کوتیشن استفاده نمایید. مثال زیر را ببینید:

< ?php
$myplugin_website = ‘http://example.com/’;
echo “ < a href=’$myplugin_website’ > Visit Example.com < /a > ”;

? >

استفاده از Tab

همانطور که هر برنامه‌نویس حرفه‌ای می‌داند، استفاده از tab در ابتدای خطوط باید با توجه به ارتباط منطقی بین بلاک‌ها باشد. به طوری که کد خواناتر بشود. تکه کد بدون استفاده از tab نوشته شده است:

if ( condition ) {

echo ‘Yes’;

} elseif ( condition2 ) {

echo ‘No’;}

خواندن این تکه کد دشوار است. حال با استفاده از tab:

< ?php

if ( condition ) {

echo ‘Yes’;        

} //end of if

elseif ( condition2 ) {

echo ‘No’;            

}//end of else if
? >

بهتر است همانند مثال بالا، در ابتدا و انتهای بلاک‌های طولانی کد از کامنت استفاده کنید.

نکته دیگر اینکه بهتر است در هنگام برنامه‌نویسی برای وردپرس، elseif را به صورت سر هم بنویسید نه به صورت else if

PHP کوتاه

از تگهای کوتاه PHP به فرم <?  ?> استفاده نکنید. هر سروری از این تگ‌ها پشتیبانی نمی‌کند. باید سرور را تنظیم کنید. در بسیاری از هاست‌ها این ویژگی غیرفعال شده است. بهتر است از تگ‌های <?php ?> استفاده کنید.

دستورات SQL

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

<?php $SQL = ‘SELECT `username` FROM `table1` WHERE status = `active`’ ?>
استانداردهای کدنویسی HTML در وردپرس

یکی از روش‌های خیلی خوب برای ارزیابی کدهای HTML استفاده از W3 HTMLValidator است. نکات زیر را به یاد داشته باشید:

  • تمامی تگ‌ها باید بسته شوند.
  • تگ‌هایی مثل <br> که بسته ندارند، باید با یک فاصله به صورت <br /> نوشته شوند.
  • تمامی Attribute ها به حروف کوچک باید نوشته شده و مقداردهی شوند. مقدار Attribute باید در دابل کوتیشن یا سینگل کوتیشن قرار بگیرد.
  • بهتر است کدهای HTML تب‌گذاری شوند.

 



Add Comment Register



پاسخ دهید

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

ورود اعضای سایت

ماهنامه باشگاه وردپرس

دانلود رایگان

ما را دنبال کنید

نمادها

اینستاگرام



لطفا نام و ایمیل خود را وارد کنید
تا این آموزش ارزشمند همین الان برایتان ایمیل شود

فیلم آموزشی را همین الان برایم ایمیل کن
چند ثانیه تا دانلود فاصله دارید!
کافی است آدرس ایمیلتان را وارد کنید
ما هم مثل شما از ایمیل های مزاحم متنفریم
چند ثانیه تا دانلود فاصله دارید!
کافی است آدرس ایمیلتان را وارد کنید
ما هم مثل شما از ایمیل های مزاحم متنفریم
چند ثانیه تا دانلود فاصله دارید!
کافی است آدرس ایمیلتان را وارد کنید
ما هم مثل شما از ایمیل های مزاحم متنفریم
دانلود این فیلم آموزشی با کیفیت اصلی
کافی است آدرس ایمیلتان را وارد کنید
ما هم مثل شما از ایمیل های مزاحم متنفریم
دانلود اولین ماهنامه تخصصی وردپرس
کافی است آدرس ایمیلتان را وارد کنید
ما هم مثل شما از ایمیل های مزاحم متنفریم