تنسيق برمجة لغة جافا المواصفات العليا

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

جدول المحتويات

1. مقدمة

2. نطاق التجربة

3. مواصفات تسمية Java-

3.1 اتفاق عام

3.2 ملفات جافا ، حقائب ، حقائب

3.3 فئة ، مواصفات تسمية الواجهة

3.4 طريقة تسمية المواصفات

3.5 ثابت

3.6 المتغيرات والمعلمات

3.7 مكون/مكون

3.8

3.9 رقم غامض

3.10 آخرون

3.11 جافا استثناء

3.12 صفيف تسمية

3.13 قواعد تسمية جدول قاعدة البيانات

3.14 قواعد تسمية حقل قاعدة البيانات

3.15 اسم ملف JSP

3.16 اسم servlet

4. كتابة مواصفات تنسيق

4.1 إنتيكس

4.2 الفضاء

4.3 محاذاة

4.4 خط فارغ

4.5 ملاحظة

5. نمط ملف الرمز

1. مقدمة لضمان قابلية قراءة برنامج مصدر النظام ، وبالتالي تعزيز صيانة النظام للنظام ، وصياغة مواصفات البرمجة التالية لتنظيم برمجة النظام. يجب أيضًا تعديل برامج المصدر في الموارد الأخرى الموروثة بواسطة النظام وفقًا لذلك وفقًا لهذه المواصفات.
2. سيتم استخدام نطاق التجربة لهذا المستند كتنسيق برمجة لتطوير برنامج نظام تطبيق Hebei البريدي (لغة Java). أثناء عملية الترميز والاختبار والصيانة للنظام ، يجب ملاحظتها بدقة.
3. مواصفات تسمية Java
3.1 تسمية اسم الملف المصدر ، الطريقة ، الدليل ، الحزمة ، اسم جدول قاعدة البيانات ، حقل قاعدة البيانات ، إلخ. في اسم الملف المصدر ، الطريقة ، الدليل ، الحزمة ، اسم جدول قاعدة البيانات ، اسم جدول قاعدة البيانات ، حقل قاعدة البيانات. قاتمة
يتم التعبير عن التسمية المستخدمة من قبل النظام في اختصارات اللغة الإنجليزية. قاتمة
طريقة التسمية هي: بادئة+{تسمية اختصار Word} ، تعبر البادئة عن استخدام التسمية ، مثل جداول قاعدة البيانات. قاتمة
يتم تحديد بادئة التسمية من قبل فريق المشروع. قاتمة
كائنات أخرى باستثناء كائنات الصيانة العامة للنظام ، يستخدم جميع التسمية حقيبة صغيرة. تستخدم إحدى الطرق "_" كرمز اتصال ، والآخر هو توصيل الأحرف الأولى من كلمة Prime مباشرة. في هذه المواصفات ، يعتمد اسم قاعدة البيانات وحقل قاعدة البيانات بالطريقة الأولى ، والباقي بالطريقة الثانية. قاتمة
يمكن استخدام يمكن أن يوضح بدقة واصف اللغة الإنجليزية الكاملة للمتغير/الحقل/الفئة/الواجهة/الحقيبة. على سبيل المثال ، باستخدام أسماء مثل FirstName أو ListAllusers أو CorporateCustomer ، يُمنع تمامًا استخدام Pinyin الصيني والكلمات غير ذات الصلة. ، والطرق ، والمتغيرات ، والحقول ، وما إلى ذلك.
باستخدام خلط صغير لتحسين قابلية قراءة الاسم. بشكل عام ، يجب استخدام الأحرف الصغيرة ، ولكن يجب أن تكون الأحرف الأولى من الأسماء وأسماء الواجهة ، والحرف الأول من أي كلمة وسيطة يجب أن تكون كبيرة. جميع أسماء الحزم. قاتمة
حاول استخدام أقل اختصارات ، ولكن إذا كان يجب عليك استخدامها ، عند استخدام الاختصارات العامة والاختصارات المعتادة ، يمكن اختصارها مثل التنفيذ على أنها ضحية ، يمكن اختصار المديرين (المدير) مثل MGR ، إلخ. إساءة استخدام سوء المعاملة. （تجنب استخدام أسماء طويلة (يفضل أن لا يزيد عن 25 حرفًا).

تجنب استخدام الأرقام ، ولكن يمكن استخدام 2 بدلاً من ، 4 بدلاً من ، وما إلى ذلك ، مثل: GO2JSP.

3.2 ملف Java ، حقيبة 
يجب أن يكون اسم الملف هو نفسه فصوله ، ويتم رسملة الحرف الأول من الكلمة. قاتمة
تم تسمية اسم الحزمة عمومًا باسم المشاريع أو الوحدات النمطية ، ويستخدم اختصارات أقل وأسماء طويلة. قاتمة
الحزمة الأساسية: com.czpost ، جميع الحزم والملفات تنتمي إلى هذه الحزمة.
يتكون الحزمة من القواعد التالية: [اسم Project].
يجب عدم تعريف الفصل مباشرة تحت الحزمة الأساسية.

3.3 فئة وواجهة تسمية مواصفات  كل كلمات كل الكلمات. استخدم الكلمات التي يمكن أن تكون متشابهة تمامًا ، معنى الواجهة ، الوظيفة ، إلخ. عموما يستخدم الأسماء. قاتمة
يمكن أن تجلب الواجهة بادئة أو قادرة ، ible ، e وغيرها من اللاحقة.

3.4 طريقة تحديد تسمية طريقة تسمية طريقة معيار التسمية يجب أن تستخدم واصفات إنجليزية كاملة ، والاستخدام المختلط لأحرف صغيرة: الحروف الأولى من جميع الكلمات الوسيطة. غالبًا ما تستخدم الكلمة الأولى لطريقة الطريقة الفعل مع لون عمل قوي. تستخدم قيمة القيمة بادئة GET ، وتستخدم فئة القيمة بادئة SET ، وتستخدم فئة الحكم هي (HAS) بادئة. مثال: GetName () setSarry () Islogon () تسلسل المعلمة: (بواسطة المشغل ، محتوى التشغيل ، شعار التشغيل ، آخرون) مثال: استبدال الفراغ العام (String sourcestr ، String Oldstr ، String Newstr) {...... ...}

3.5 يستخدم الثابت كلمة ذات رسملية إنجليزية كاملة ، ويتصل بالخط بين الكلمات والكلمات ، مثل: default_value

3.6 المتغيرات ومتغيرات المعلمة يوصى باستخدام طريقة التسمية الهنغارية.
متغير منصة (بما في ذلك int ، قصيرة ، طويلة): ابدأ بـ n ، على سبيل المثال: ncrednum long ؛
متغيرات نقطة العائمة (بما في ذلك التعويم ، مزدوج): ابدأ بـ F ، على سبيل المثال: مزدوج ftranamt ؛
متغير الحرف: ابدأ بـ C ، على سبيل المثال: char cpageflag ؛
المتغير: ابدأ بـ D ، على سبيل المثال: Date Dtoday ؛
متغيرات السلسلة: ابدأ بـ S ، على سبيل المثال: Char Spageno [2+1] ؛
المتغيرات العالمية: نوع البيانات مع G ، على سبيل المثال: Chsbankno [10+1] ؛
المتغيرات الثابتة: المتغيرات الثابتة هي أيضًا متغيرات عالمية في الملفات ، وقواعد التسمية هي نفس المتغيرات العالمية. قاتمة
متغيرات النظام: متغيرات النظام هي أيضًا متغيرات عالمية.
على سبيل المثال: char _sbankno [10+1] لا يوجد 'g'.
عادةً ما تتم تسمية المتغيرات المؤقتة I و J و K و M و N ، وتستخدم عمومًا في عدد صحيح ؛

3.7 يجب أن تتبنى المكونات/المكونات مكونًا كاملًا لتسمية الوصف الإنجليزي (مكون الواجهة) ، يليه قواعد التسمية المجرية مثل: Btnok ، LBLName. T repable butable btn+xxxxxxx ، على سبيل المثال: btnsave ، btn exit ، btnprint ، إلخ.

3.8 يجب تسمية مجموعة ، مثل Array و Vector ، بأرقام متعددة لتمثيل نوع الكائن المخزن في قائمة الانتظار. يجب أن تستخدم التسمية واصف اللغة الإنجليزية الكاملة. مثل: Vector vProduts = New Vector () ؛

3.9 تستخدم برامج الأرقام الغامضة بعض الكميات. لاحظ أن تسمية هذا الثابت يجب أن يعبر عن أهمية الرقم ، ويجب أن يكون كله كبيرًا ، والذي يتم تمييزه عن المعرف المقابل للمتغير. على سبيل المثال ، يمكن تعريف الرقم 50 كبديل ثابت يسمى num_of_employees.

3.10 يجب استخدام الزوجي عندما تشير التسمية الأخرى إلى أنها تمثل قيمًا متعددة. مثل: OrderItems.

3.11 فئة Java غير طبيعية غير طبيعية تتكون من الكلمات التي تمثل النوع غير الطبيعي والاستثناء ، مثل ActionXception.
تستخدم المثيلات غير الطبيعية عمومًا E ، Ex ، إلخ. في تشوهات متعددة ، استخدم هذا الاسم أو الاختصار غير الطبيعي لإضافة E ، Ex ، إلخ.

3.12 يجب تسمية المصفوفات المصفوفة بالطريقة التالية: Byte [] Buffer ؛

3.13 يتم فصل قواعد التسمية لجدول قاعدة البيانات بالخطوط السفلية بين البادئة وكلمة التسمية.字 اسمه يتكون من حرف صغير. قاتمة
إذا كانت كلمة التسمية تتكون من كلمة واحدة ، فيمكن استخدامها للتهجئة الكاملة ؛ بين الاختصارات ، استخدم الخط السفلي. على سبيل المثال: 库 例 例: ابدأ بـ 't_'  العرض: ابدأ بـ 'v_'            例 例 例: بدأ بـ 't_' ، والفهرس الوحيد للمكتبة الجدول في نهاية "_idx": "نهاية

3.14 قواعد تسمية حقل قاعدة البيانات 
إذا كانت كلمة التسمية تتكون من كلمة واحدة ، فيمكن استخدامها للتهجئة الكاملة ؛ بين الاختصارات ، استخدم الخط السفلي.字 اسمه يتكون من حرف صغير.  لا يوجد بادئة.

3.15 يستخدم تسمية ملف JSP وصفًا كاملاً للغة الإنجليزية للإشارة إلى الوظيفة التي تم الانتهاء منها بواسطة JSP ، بما في ذلك الفعل الحي ، أو الرسائل الأولى ، مثل: viewmessage.jsp ، edituser.jsp أو forumchooser.jsp ، إلخ.

3.16 يتوافق اسم فئة Servlet بشكل عام مع الكائنات التي يتم تقديمها مع خدمة لاحقة ، مثل: userviservice ، Targeservice ، إلخ.

4. يتطلب تنسيق الكتابة بشكل صارم أن يجعل المبرمجون الموحدون من السهل القراءة والأناقة. يوصى بأن يقوم برنامج المصدر بتطوير أداة Eclipse ، ومواصفات التنسيق مسبقًا في الأداة.

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

4.2 من حيث المبدأ ، تكون المتغيرات والفئات والبيانات المستمرة والوظائف في الفضاء من حيث المبدأ في نوعها ، والاسم المعدل متباعدة بشكل صحيح ومحاذاة وفقًا للوضع. يمكن استخدام المرء في مبدأ الكلمات الرئيسية ، مثل: if (...) وهلم جرا. متطلبات المساحة للمشغل هي كما يلي: "::" ، "->" ، "[" ، "" ، "++" ، "،" ، "" ، "!" ، "+"---- "(يشير إلى الرقم الإيجابي) ،" & "(مقتبس) وغيرهم من المشغلين مثل جانبي الحساب لا يخلو من المسافات (التي يشير نظام رمز الحوسبة الواحد إلى الجانب المتصلين بالعملية) ، والآخر يمكن للمشغلين (بما في ذلك معظم المشغلين والمشغلين والمشغلين في الغرض و "مشغل ثلاثي الأثرياء"؟: يتم تنفيذها. "يمكن أن تكون الشبكة فارغة أو متعددة الفضاء عندما تحتاج إلى المحاذاة.

4.3 يجب محاذاة الخطوط الإغلاق للمحاذاة من حيث المبدأ ، ويتضمن المحاذاة جميع الأجزاء مثل الأنواع والتعديلات والأسماء والمعلمات. يجب ألا يتجاوز طول كل سطر الشاشة أكثر من اللازم. المسافة البادئة للخط الأول ، أي إذا كان السطر التالي "{" ، فيجب أن يتوافق مع السطر الأول. من الأفضل أن تتماشى التعريفات المتغيرة مع إضافة المساحات أو مفاتيح TAB ، والمتغيرات من نفس النوع هي الأفضل معًا. كما هو موضح في المثال التالي: int nvalue ؛

4.4 يجب أن يكون هناك خطوط فارغة غير منتظمة في الخط الفارغ ، مثل عشرة خطوط فارغة متتالية. كل جزء من بنية ملف البرنامج فارغة. بالنسبة للوظائف التي تكتبها ، يوصى بإضافة "// -------" للانفصال. يجب أن يكون سطر واحد على الأقل فارغًا بين البيانات الداخلية للوظيفة والرمز. منه. هناك سطر واحد على الأقل بين "P" الأربعة في الفصل ، ويجب أن تكون البيانات والوظائف فارغة أيضًا.

4.5 ملاحظات الملاحظات هي تجسيد محدد لقدرة البرامج. تمثل التعليقات التوضيحية للبرنامج عمومًا 20 ٪ من عدد ترميز البرامج ، ومتطلبات هندسة البرمجيات لا تقل عن 20 ٪. لا يمكن استخدام تعليقات البرنامج في اللغات المجردة مثل "المعالجة" و "Cycle" بلغة مجردة. تجنب التعليقات من كل صف من الإجراءات ، يمكنك إضافة تعليق أمام البرنامج ، مع منطق معالجة واضح. التعليقات ضرورية ، ولكن يجب أن تكون أكثر من اللازم. فيما يلي أربع ملاحظات ضرورية:  العنوان ووصف إضافي.的 شرح الوظائف والفئات ، إلخ. يجب أن تكون هناك تفسيرات مناسبة لكل وظيفة تقريبًا. ، إذا لزم الأمر ، يجب أن يكون هناك بعض الإرشادات مثل متطلبات البرامج والأجهزة الخاصة. يجب تفسير بيان الوظائف العامة والطبقات العامة من خلال الطريقة والتصميم. قاتمة
يجب أن يكون هناك تفسير معين في غير واضح أو غير زرع. قاتمة
وكمية صغيرة من الملاحظات الأخرى ، مثل تعليقات المتغيرات المخصصة ، ووقت كتابة التعليمات البرمجية ، إلخ.

5. يجب أن تتبع نمط ملف رمز جميع ملفات Java (*. Java) قواعد النمط التالية: 
لتوليد الملفات ، لفئة مشتقة Java الموحدة ، حاول استخدام أداة Eclipse لإنشاء تنسيق الملف لتجنب ملفات/ملفات الرأس المصنوعة يدويًا. يجب أن يكون سطر حزمة الحزمة/الاستيراد قبل خط الاستيراد ، ويكون اسم الحزمة القياسي في الاستيراد قبل اسم الحزمة المحلية ، وترتيبها بترتيب الحروف. إذا كان صف الاستيراد يحتوي على الأثرية الفرعية المختلفة في نفس الحزمة ، فيجب معالجته باستخدام*.
حزمة hotlava.net.stats ؛ قاتمة
يعرض شرح رئيس ملف توضيح رئيس الملف بشكل أساسي بعض المعلومات عن الملف ، وهو الوصف العام للبرنامج ، والذي يمكن أن يعزز قابلية القراءة والصيانة للبرنامج. يكون شرح شرح رأس الملفات بشكل عام وراء بيان الحزمة/الواردات ، ووصف الفصل. يجب أن تكتب على الأقل أسماء الملفات والمبدعين ووقت الإنشاء وأوصاف المحتوى. يجب أن يكون التنسيق مقيدًا قدر الإمكان: /*** العنوان: موافق لتحديد فئة موضع الماوس* الوصف: تحديد حقل الوظيفة الآن وإرجاع رقم الوظيفة* @copyright: حقوق الطبع والنشر (C) 2002* Company: HIT * Authoror: Rivershan * version: 1.0 */  الفصل التالي هو تعليقات الفصل ، والتي تستخدم عمومًا لشرح الفصل. / ** * فئة تقمع مجموعة من الحزم والبايت Technus * يمكن ملاحظتها للسماح لها بأن تكون watchet ، ولكن فقط * تقارير تتغير عندما تكون المجموعة الحالية إكمال e */ التالي هو تعريف فئة ، والذي يحتوي على خطوط مختلفة يمتد وينفذ عدادات الطبقة العامة يمتد الأدوات القابلة للملاحظة

التالي هو متغير عضو: / ** * حزم الحزم * / حزم int [] المحمية ؛ إذا كانت متغيرات الأعضاء المحددة بواسطة Procity و Private و Package واضحة ، فلا يوجد تعليق.是 طريقة الوصول هي الطريقة للوصول إلى المتغير. إنه مجرد استخدام متغيرات الفصل للحصول على القيمة ، والتي يمكن كتابتها ببساطة على السطر. (شخصيا يعتقد أن محاولة الكتابة قدر الإمكان)

/** احصل على عدادات * @صفيف يحتوي على بيانات الإحصاء.

 public int [] getPackets () {return copyarray (حزم ، إزاحة) ؛} public int [] getBytes () {return copyarray (bytes ، Office)] {this.packets = packets ؛}

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

عدادات عامة (حجم int) {

this.size = الحجم ؛

} 

إذا كان يمكن استنساخ طريقة الاستنساخ ، فإن الخطوة التالية هي طريقة الاستنساخ: كائن عام clone () {)

يحاول {

الكائن OBJ = (countret) super.clone () ؛

} catch (clonenotsupportedException e) {{

رمي الإنترنت الجديد ("clonenotsupportexception غير المتوقع:" + E.GetMessage ()) ؛

}

} 

بدأت طريقة الفصل في كتابة طريقة الفصل:

/ ** * قم بتعيين عدد الحزم * galargumentexcetion {

// تأكد من أن المصفوفات متساوية الحجم // إذا (r1.length! = r2.length || r1.length! = r3.length || r1.length! = r4.length) أيون ("يجب أن تكون الصفائف من حجم الأخبار "؛ system.arraycopy (r1 ، 0 ، r3 ، 0 ، r1.length) ؛ system.arraycopy (r2 ، 0 ، r4 ، r4 ، r1.length) ؛ يجب أن تحدد فئة واحدة طريقة toString:

 السلسلة العامة toString () {string retval = "countret:" ؛ () ؛} إرجاع retval ؛}

إذا تم تعريف الطريقة الرئيسية ، فيجب كتابتها في الجزء السفلي من الفصل.