مواصفات ترميز جافا سكريبت الأكثر اكتمالا (الموصى بها)

1. التضمين القواعد

يجب وضع برامج JavaScript في ملفات .js قدر الإمكان. عندما تحتاج إلى الاتصال بهم ، يجب عليك تضمينها في شكل <script src = "filename.js"> على الصفحة. إذا لم يكن رمز JavaScript مخصصًا للصفحة ، فحاول تجنب كتابة رمز JavaScript مباشرة على الصفحة.

2. محاذاة المسافة البادئة وكسر الخط

أ) المسافة البادئة

يجب اعتماد نفس معيار المسافة البادئة في نفس النظام. يدعو هذا المقال إلى أن حجم المسافة البادئة هو 4 مسافات. يحدد كل مترجم أحجام فارغة مختلفة لمفاتيح TAB. يوصى بإعادة تعيين مفاتيح اختصار TAB في المحرر إلى 4 مسافات عند إعداد بيئة التطوير. يقدم معظم المترجمين هذه الميزة. خلاف ذلك ، يوصى بالضغط على 4 مسافات إلى المسافة البادئة.

ب) كسر الخط

يجب أن تكون فواصل الخط:

بعد انتهاء كل بيان مستقل ؛

إذا ، وإلا ، اصطحب ، أخيرًا ، أثناء الكلمات الرئيسية مثل الكلمات الرئيسية ؛

عندما يكسر المشغل خطًا ، يجب أن يكون المشغل في بداية الخط الجديد.

بالنسبة لكسر الخط الذي يحدث عندما يتجاوز طول سطر واحد الحد ، افصل السياسة المرجعية في الطول.

1). السلسلة طويلة جدًا ومقطوعة

يجب أن يكون كل سطر من الكود أقل من 80 حرفًا. إذا كان الرمز طويلًا ، فحاول كسر الخط. يجب اختيار الخط الجديد بعد المشغل وعلامة علامات الترقيم ، ويفضل أن يكون ذلك بعد الفوسيني "؛" ؛ أو فاصلة "،". يتم وضع مسافة بادئة للسطر التالي من الكود من خلال 4 مسافات بالنسبة للخط السابق. يمكن أن يمنع هذا بشكل فعال الأخطاء المفقودة في الكود الناتج عن ملصق النسخ وتعزيز قابلية القراءة.

اقتطاع السلسلة بطول معين واستخدم مشغل + للتسلسل. حاول أداء الدلالات قدر الإمكان ، مثل عدم كسر الاسم الكامل. على وجه الخصوص ، بالنسبة لربط شظايا HTML ، يتم الحفاظ على نفس بنية HTML عن طريق المسافة البادئة:

يمكنك أيضًا استخدام المصفوفات لصقها ، وهو أمر أسهل في ضبط المسافة البادئة من عمليات +:

2). المشغل الثلاثي طويل جدًا

يتكون المشغل الثلاثي من 3 أجزاء ، لذلك يجب أن تشكل فترات أسطره 3 مواقف مختلفة وفقًا لطول كل جزء:

لا تحدث المواقف التالية:

3). مجموعة حالة منطقية طويلة بشكل مفرط

عندما لا تستطيع 80 حرفًا تلبية الاحتياجات بسبب المزيج المعقد من الظروف المنطقية ، يجب وضع كل حالة بشكل مستقل عن سطر واحد ، ويجب وضع المشغل المنطقي في بداية الخط للفصل ، أو يجب فصل جزء من المنطق بواسطة مجموعة منطقية. أخيرًا ، ضع الأقواس الختامية) والأقواس الافتتاحية {على خط مستقل للتأكد من أن البيان يحظر مع IF بسهولة. يحب:

4). طويل للغاية JSON و ARRAY

إذا كان هناك العديد من خصائص الكائنات ، مما يتسبب في أن يشغل كل خاصية مساحة كبيرة ، فيمكن تنظيمها عن طريق الدلالات أو المنطق ، مثل:

من خلال 5 مجموعات من المجموعات ، يتم التحكم في كل صف في نطاق معقول ويتم تجزئها منطقياً. بالنسبة للمصفوفات التي تحتوي على المزيد من المشاريع ، يمكن أيضًا استخدام نفس الطريقة ، مثل:

5). بيان العودة

إذا تم استخدام تنفيذ التعبير كقيمة الإرجاع ، فيرجى وضع التعبير والعودة في نفس السطر لتجنب إساءة تفسير الخط الجديد على أنه نهاية البيان والتسبب في خطأ في الإرجاع. إذا لم يتم إرجاع أي تعبير بعد الكلمة الرئيسية للعودة ، فسيتم إرجاع غير محدد. قيمة الإرجاع الافتراضية للمُنشئ هي هذا.

مثال:

3. تسمية

عادة ما يكون لأساليب التسمية الفئات التالية:

أ). وصف التسمية

1).

2).

3). تسطير التسمية ، مثل هذا _is_an_apple ・

4). إن تسميات العلامات الأوسط مثل هذا المنفث

اعتمادًا على أنواع مختلفة من المحتوى ، يجب اعتماد التسمية التالية بشكل صارم:

ب). الاسم المتغير: يجب استخدام تسميات الإبل

ج). اسم المعلمة: يجب استخدام تسمية الإبل

د). اسم الوظيفة: يجب استخدام تسمية الجمل

ه). الطريقة/الممتلكات: يجب استخدام تسمية الجمل

و).

ز). الاسم الثابت: يجب استخدام جميع التسمية السفلية الرأسمالية ، مثل is_debug_enabled

ح). اسم class: يجب استخدام تسميات Pascal

أنا). اسم التعداد: يجب استخدام تسميات Pascal

ي). خصائص التعداد: يجب استخدام التسمية السفلية في جميع العواصم

ك). مساحة الاسم: يجب استخدام تسمية الإبل

ل).

يجب استخدام الأسماء للأسماء المتغيرة ؛

يجب أن يبدأ نوع Boolean Is ، Have ، وما إلى ذلك للإشارة إلى نوعه ؛ ・

يجب أن تستخدم أسماء الوظائف عبارات الفعل ؛

يجب أن تكون أسماء الفصل مع الأسماء.

4. التعليقات

يجب أن تكون التعليقات بسيطة قدر الإمكان وواضح قدر الإمكان. ركز على معنى التعليقات والتعليق على الأجزاء الأقل سهولة:

(بالطبع ، لا ينصح بممارسة تحديد مجموعة من المتغيرات العالمية بشكل مباشر)

بالإضافة إلى ذلك ، تحتوي تعليقات JavaScript على نوعين من "//" و "/ * ...... */". يوصى باستخدام "//" كخط من تعليقات التعليمات البرمجية ، ويتم استخدام النموذج "/ * .... */" كإلغاء لقطاع الكود بأكمله ، أو في إعلانات أكثر رسمية ، مثل أوصاف معلمات الوظيفة ، وظائف ، وظائف الملف ، إلخ.:

بالإضافة إلى ذلك: عند النسخ واللصق ، يجب عليك الانتباه إلى ما إذا كانت التعليقات تتوافق مع الرمز.

5. بيان

1). إعلان متغير

على الرغم من أن لغة JavaScript لا تتطلب إعلانات متغيرة قبل استخدامها. ولكن لا يزال يتعين علينا تطوير هذه العادة الجيدة. هذا يجعل من السهل اكتشاف المتغيرات غير المعلنة ، وتجنبها أن تصبح متغيرات عالمية مخفية وتسبب مخاطر خفية.

في بداية الوظيفة ، يجب عليك أولاً استخدام الكلمة الرئيسية VAR لإعلان المتغيرات المحلية التي سيتم استخدامها في الوظيفة ، والتعليق على وظائف ومعاني التمثيلية للمتغيرات ، ويجب فرزها أبجديًا. يأخذ كل متغير سطر واحد لإضافة تعليقات. وذلك لأن فقط {} للدالة في JavaScript يشير إلى النطاق ، فإن المتغيرات المحلية المعلنة مع الكلمة الرئيسية VAR صالحة فقط داخل الوظيفة ، في حين أن المتغيرات التي لم تعلنها VAR تعتبر متغيرات عالمية. مثال:

هناك فرق بين Valuea المتغير المعلن مع VAR ومعلن VALUEB المتغير دون إعلان. من المهم بشكل خاص ملاحظة أن المتغير المعلن مع VAR داخل الوظيفة هو متغير محلي ، والذي يمكن أن يتجنب بشكل فعال الأخطاء الناجمة عن نفس اسم المتغير المحلي والمتغير العالمي.

2). إعلان الوظيفة

يجب أيضًا الإعلان عن الوظائف قبل الاتصال ، ويجب إعلان الوظائف الداخلية بعد عبارات VAR التي تعلن عن المتغيرات الداخلية ، والتي يمكن أن تشير بوضوح إلى نطاق المتغيرات الداخلية والوظائف الداخلية.

بالإضافة إلى ذلك ، يجب أن يكون هناك مسافة بين اسم الوظيفة فورًا بين القوس الأيسر "(" ، والقوس القريب ")" و "{" لعرض اسم الوظيفة بوضوح مع جزء المعلمة الخاص به وبداية جسم الوظيفة. إذا كانت الوظيفة وظيفة مجهولة المصدر/بدون اسم ، اترك مساحة بين الكلمة الرئيسية للوظيفة وسعة الفتحة "(" ، وإلا فقد يكون مخطئًا لاسم وظيفة الوظيفة.

مثال على إعلان الوظيفة الداخلية:

من إخراج المثال أعلاه ، يمكن ملاحظة أن وظيفة INF () تسري فقط داخل وظيفة OUTF () ، ويصبح المتغير الداخلي المحلي مفعولًا على نطاق الوظيفة الداخلية. طريقة الترميز هذه تجعل نطاق المتغيرات والوظائف واضحة.