افضل الممارسات لتسميه المتغيرات و الدوال والكلاسات

هذه بعض افضل الممارسات لمبرمجين الجافا ينبغي اتباعها اثناء كتابه الكود البرمجي


1 - تجنب  الاسماء التي لا معنى لها 

تجنب كتابه الاسماء التي لا معني لها مثل x , y ,ad التي لا تؤدي الى نيه انها ببساطه تقلل من قابليه كتابه الكود وهي الانسب للبرامج التي تحتوي علي 50 سطر برمجي او اقل
لا تستخدم هكذا نوع  من التسميات في المشاريع الاحترافيه لماذا ؟ لانه لايمكن بعد فتره ان يتم اختبار المشروع 

2 - استخدم اسماء ذات معني

قدم اسماء ذات معني التي تكشف عن نيه المبرمج مثال اذا كانت اسم الداله getPayDate() هو افضل بكثير من getPD() حيث عند قراءه هذا الداله انا اعرف انها ترجع تاريخ الدفع حتى بعد عده سنوات 

3 - تفضيل الاسم القصير على الطويل اذا كان يكشف عن النيه بوضوح 


استخدام الاسم القصير يسهل عمليه الكتابه والقراءه 

4 -  تجنب اسماء مماثلة 


لا شيء اسوء من الاسماء المماثلة مثلا text و texts حيث من الصعب التفرقه بينها وتؤدي الى مشاكل بسبب سوء الفهم 

5 -  اتبع تعليمات جافا للكود 


اتبع تعليمات جافا في كتابه الكود خصوصا اذا كنت تكتب برامج مفتوحه المصدر وهذا يجعل من السهل لمبرمج اخر قراءه الكود والتعامل معه  وهذه بعض تعليمات جافا للكتابه
  1. بدايه اسم الكلاس بحرف كبير
  2. اسماء المتغيرات والدوال الكلمه الاولى حرف صغير ثم التي بعدها حرف كبير
  3. المتغيرات التي تكون static تكون كل حروفها كبيره MAX_QUANTITY

6- تجنب المرادفات 

 
اختيار الكلمه المناسبه من عده مرادفات لها 
 

7-اسماء العدادات 

 
من الشائع استخدام الحرفين i و j في الدوارات 
for(int i = 0 ; i<8;i++)
 

 8- يجب ان يكون اسم الكلاس اسم وليس غيره


اسم يدل على عمل الكلاس مثل موضف, خدمات , وغيراها


9- تجنب استخدام _m _ n_ 

 

10- من الجيد استخدام بعض هذه الافعال 

 
do can has is لارجاع boolean , حيث يمكن استخدامها للدوال والمتغيرات مثال 
canExecute ,, hasNext ,, isAlive 

 





تعليقات

المشاركات الشائعة من هذه المدونة

مقدمة عن Dagger 2

local function

Architecture patterns in Android part 1 - معماريه كتابه الكود في الاندرويد جزء 1