استانداردهای کدنویسی جاوا اسکریپت در وردپرس (3)

27 فروردین 1399
wordpress-theme-design-standards-07

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

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

ادامه ی استانداردهای افزودن جاوا اسکریپت به وردپرس به شرح زیر می باشند:

نامگذاری ها

نام متغیرها باید از کلمات کامل تشکیل شده باشد. نام گذاری باید به صورت camel case انجام شود ( اما حرف اول کلمه اول کوچک باشد).

نام ها باید توصیفگر و غیرتکراری باشند، البته استثنائاتی نیز وجود دارد (مثل استفاده از i در حلقه ها).

اختصارات و مخففات

کلمات مخفف (abbreviation) باید با حروف بزرگ نوشته شوند. این موضوع نشان دهنده ی آن خواهد بود که هر حرف بزرگ سرآغاز یک کلمه است.

مختصر نویسی ها (acronym) باید به صورت کمل‌کیس یا camel case نوشته شوند. یعنی حرف اول هر کلمه باید با حروف بزرگ و باقی حروف مربوط به آن کلمه باید با حروف کوچک نوشته شود.

اگر یک مخفف یا مختصرنویسی، در اول نام یک متغیر ظاهر شود، باید به صورت کمل‌کیس نوشته شود و نیز شامل اولین حرف متغیر یا کلاس مربوطه باشد. این حرف باید در متغیرها با حروف کوچک، و برای کلاس ها با حروف بزرگ نوشته شود.

// "Id" is an abbreviation of "Identifier":
const userId = 1;
 
// "DOM" is an acronym of "Document Object Model":
const currentDOMDocument = window.document;
 
// Acronyms and abbreviations at the start of a variable name are consistent
// with camelcase rules covering the first letter of a variable or class.
const domDocument = window.document;
class DOMDocument {}
class IdCollection {}

تعریف کلاس ها

سازنده هایی که بعد از عبارت new می آیند، باید حرف اول کلماتشان بزرگ باشد. (UpperCamelCase)

برای تعریف کلاس ها، همواره و در هر شرایطی باید از نوشتن به صورت UpperCamelCase عمل شود.

class Earth {
    static addHuman( human ) {
        Earth.humans.push( human );
    }
 
<pre><code>static getHumans() {
    return Earth.humans;
}
</code></pre>
 
}
 
Earth.humans = [];

همه ی کامپوننت های @wordpress/element و کامپوننت های مربوط به فانکشن هم باید به صورت بالا نام گذاری شوند.

ثابت ها (Constants)

در اکثر موارد، ثابت ها باید در بالاترین نقطه ی فایل تعریف شوند. حتما توجه داشته باشید که وظیفه ی ثابت const در جاوا اسکریپت بسیار محدودتر از آن چیزی است که در اینجا به آن اشاره می کنیم. وقتی که یک مقدار (value) بوسیله ی const یا به عنوان یک ثابت تعریف می شود، دیگر نمی توان مجددا به آن مقدار داد، یا آن را بازتعریف کرد. استفاده از ثابت ها نوعی محدودیت در بازتعریف مقادیر ایجاد می کند و بدین وسیله از بروز خطا جلوگیری کرده و به توسعه دهندگان کمک می کند.

کامنت ها یا نظرات (Comments)

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

someStatement();
 
// Explanation of something complex on the next line
$( 'p' ).doSomething();
 
// This is a comment that is long enough to warrant being stretched
// over the span of multiple lines.

نیاز به ذکر نیست که برای کامنت های چند خطی از **/ استفاده می شود.

کامنت های درون‌خطی که برای توضیح یک آرگومان مورد استفاده قرار می گیرند نیز  به شکل زیر نوشته می شوند:

function foo( types, selector, data, fn, /* INTERNAL */ one ) {
    // Do stuff
}

برابری ها (equality)

موارد زیر راه های پیشنهادی برای بررسی نوع (type) یک شیء، با استفاده از عملگر های ( == ) و ( === ) می باشند. ( type یا نوع هایی مثل: رشته (String)، عدد (Number) و غیره)

String: typeof object === 'string'

Number: typeof object === 'number'

Boolean: typeof object === 'boolean'

Object: typeof object === 'object' or _.isObject( object )

Plain Object: jQuery.isPlainObject( object )

Function: _.isFunction( object ) or jQuery.isFunction( object )

Array: _.isArray( object ) or jQuery.isArray( object )

Element: object.nodeType or _.isElement( object )

null: object === null

null or undefined: object == null

هر زمان که کتابخانه هایی مثل Backbone و Underscore در برنامه قابل دسترسی بودند، پیشنهاد می شود که از روش های «چک کردن نوع (type)» موجود در این کتابخانه ها استفاده کنید، نه از روش های کتابخانه ی جی کوئری.

رشته ها (strings)

از تک کوتیشن برای نشان دادن رشته ها استفاده کنید.

var myStr = 'strings should be contained in single quotes';

اگر خواستید خود تک کوتیشن ( ' ) را در رشته یا عبارت خود بنویسید، آنگاه باید قبل از آن یک بک اسلش ( ) بگذارید.

// Escape single quotes within strings:
'Note the backslash before the \'single quotes\'';

به پایان قسمت هفتم و استانداردهای افزودن جاوا اسکریپت به وردپرس رسیدیم. در قسمت بعدی «استانداردهای مربوط به زبان جاوا اسکریپت» را به پایان می بریم و در ادامه به سراغ «استانداردهای زبان برنامه نویسی پی اچ پی برای وردپرس» می رویم. با ما همراه باشید.


منبع: سایت WordPress

تمام فصل‌های سری ترتیبی که روکسو برای مطالعه‌ی دروس سری آموزش تخصصی استانداردهای طراحی قالب وردپرس توصیه می‌کند:
نویسنده شوید

دیدگاه‌های شما

در این قسمت، به پرسش‌های تخصصی شما درباره‌ی محتوای مقاله پاسخ داده نمی‌شود. سوالات خود را اینجا بپرسید.