مواد

• اقدامات
• برادری کے سوالات اور جوابات
• اشارے

کسی پروگرام کے لئے کوڈ لکھتے وقت ، تمام کیڑے کو درست کرنا آسان ہے اور اس کو صحیح طور پر مرتب کرنا ہے ، لیکن کسی دوسرے شخص کے لئے اسے پڑھنا آسان بنانا زیادہ مشکل ہے۔ یہ کچھ نکات یہ ہیں جو آپ کوڈ کی قابلیت کو بہتر بنانے میں معاون ثابت ہوں گے۔

اقدامات

1. 

   لوگ جو ضابطہ اخلاق کو برقرار رکھتے ہیں وہ کبھی بھی اصلی مصنف کی طرح عبور نہیں رکھتے۔ ان میں پروگرامنگ کی غریب مہارت ہوسکتی ہے اور وہ اس منصوبے کے بارے میں کم جانتے ہوں گے۔ یہ وہ شخص ہے جس کے لئے آپ پروگرام لکھ رہے ہیں۔ آپ چاہتے ہیں کہ اس شخص کے لئے کوڈ آسان ہو۔

2. 

   
   
   صرف اس وجہ سے کہ کسی زبان میں زبان کی خصوصیت دستیاب ہے ، اس کا مطلب یہ نہیں ہے کہ آپ اسے استعمال کریں۔ مقصد یہ ہے کہ کوڈ اگلے قارئین کے ساتھ کیا سلوک کرے ، اس سے متاثر نہ ہو کہ آپ کوڈ لکھنے کے ل how کتنی لائنیں لے سکتے ہیں۔

3. 

   
   
   اکثر الگورتھم کی پیروی کرنا مشکل ہوتا ہے۔ لیکن اکثر یہ کہیں کہیں شائع ہوتا ہے۔ کوڈ کے لئے تبصرہ والے حصے میں الگورتھم کے لئے دستاویزات کا URI رکھیں۔ اگر یو آر آئی کسی ایسے مقام کی طرف اشارہ کرتا ہے جو ابتدائی ہے ، تو معلومات کو کہیں سے کاپی کریں جہاں کوڈ کو برقرار رکھنے والا اسے مل سکے۔

4. 

   
   
   فائل کے ہیڈر میں کوڈنگ کے معیار کا حوالہ دیں۔ اگر ممکن ہو تو فائل فراہم کریں کہ ٹولز صحیح ترتیبات کو شامل کرنے کے لئے کھول سکتے ہیں۔ ایک مثال کے طور پر Eclipse ٹیبز کو استعمال کرنے سے پہلے سے طے شدہ ہے ، لیکن مختلف ٹیکسٹ ایڈیٹرز پر ٹیبز کو مختلف انداز میں پیش کیا جاتا ہے۔ ٹیبز کے بجائے سفید جگہ کا استعمال افضل ہوسکتا ہے لیکن ایسی فائل رکھنا جو کسی منصوبے کے لئے مناسب ترتیبات فراہم کرے۔

5. 

   سفید جگہ کا استعمال کریں۔ کوڈ کے مابین لائنز کو چھوڑیں جو مختلف چیزیں کرتا ہے ، اور سیمیکلن اور کوما کے بعد خالی جگہوں کا استعمال کریں۔ اس سے آپ کا کوڈ صاف اور پڑھنے میں آسان نظر آئے گا۔

6. 

   گھوبگھرالی منحنی خطوط وحدانی میں منحنی خطوط وحدانی اس سے یہ ایسا ہوتا ہے کہ یہ ظاہر ہے کہ کوڈ کا ایک حصہ دوسرے سے الگ ہے۔ یہ ایک طویل طریقہ لکھتے وقت مددگار ثابت ہوتا ہے۔ اگر بیانات اور لوپ کو پڑھنا آسان ہوجائے گا تو اندر انڈینٹ کرنا۔ اس تکنیک کو گھوںسلا کہتے ہیں ، اس سے یہ ظاہر ہوتا ہے کہ کوڈ کے ایک دوسرے حصے میں کوڈ کا ایک حصہ "گھوںسلا" ہے ، اور قاری کو آسانی سے گھونسلے کے طرز پر عمل کرنے کی اجازت دیتا ہے۔

7. 

   وضاحتی تبصرے لکھیں۔ فرض کریں کہ آپ کا کوڈ پڑھنے والے کو اس کے کیا کرنا ہے اس کے بارے میں کچھ نہیں جانتا ہے۔ آپ کے تبصرے میں ہر قدم کی وضاحت ہونی چاہئے۔ سب آپ کے جدید ، مبہم ، یا پیچیدہ الگورتھم کے بارے میں اچھی طرح سے تبصرہ کیا جانا چاہئے۔ نیز ، یہ بیان کرنے کی کوشش کریں کہ کوڈ کا کیا مقصد ہے۔ مثال کے طور پر ، "ایک کو متغیر میں شامل کریں ،" لکھنے کے بجائے یہ کہیں کہ ضابطہ اخلاق میں یہ کیوں ضروری ہے ، کیوں کہ کوئی بھی دیکھ سکتا ہے کہ یہ متغیر کو بڑھا رہا ہے ، جیسے "صفحہ ہٹ کی تعداد میں 1 اضافہ"۔

8. 

   وضاحتی شے کے نام تیار کرکے اپنے کوڈ کو "خود دستاویزی" بنائیں جو ان کے مقاصد کیا ہیں اس کی وضاحت کرتے ہیں۔ اشیاء کو یا تو مسئلے کے ڈومین کا حوالہ دینا چاہئے یا سافٹ ویئر کے معیاری نمونے۔ ایک فہرست ایک فہرست ہے۔ آپ کو ایک کسٹمر لسٹ بنانا پڑسکتی ہے جو فہرست کو ذیلی طبقے یا نافذ کرتا ہے۔ متغیرات اور فنکشن پیرامیٹرز میں وضاحتی نام ہونے چاہ.۔

9. 

   فائل کے ابتدائی تبصرے میں اصل مصنف اور کوڈ کے موجودہ برقرار رکھنے والے کو شامل کریں۔ یہ ان لوگوں کو بتاتا ہے جو کوڈ کی خدمت پر جائیں۔

10. 

    اکثر تبصرہ اپنے ارادے کی نشاندہی کرنے کے لئے تبصرے لکھیں۔ آپ کے کوڈ پر زیادہ سے زیادہ تبصرہ کرنے سے کوئی آپ کے تبصرے کو حذف کرے گا۔

برادری کے سوالات اور جوابات

اشارے

• آپ کے کوڈ کو پڑھنے میں آسانی پیدا کرنا آپ کو اپنے پروگرام کو ڈیبگ کرنے میں بھی مددگار ثابت ہوگا ، اور اپنے آپ کو آسان بنا دے گا۔
• انڈر سکور کے ذریعہ الگ کیے جانے والے الفاظ کے ساتھ مستقل متغیرات تمام کیپس میں ہونی چاہیں۔ باقاعدگی سے متغیر میں انڈر سکور کو چھوڑ کر ہر لفظ کے پہلے حرفوں کی سرمایہ کاری ہونی چاہئے۔
• اگر ان کی اجازت ہو تو سفید جگہیں شامل کریں۔
• اگر آپ متن کے بڑے حص chے پر تبصرہ کرنا چاہتے ہیں تو ، تبصرہ شروع کرنے کے لئے "/ *" اور اس کو ختم کرنے کے لئے " * /" استعمال کریں۔ اس کے بعد ، آپ کو ہر لائن پر "//" لکھنے کی ضرورت نہیں ہے۔ (نوٹ کریں کہ تبصرے کرنا دوسری زبان میں مختلف ہوسکتے ہیں)
• کوڈ لکھنے کا اپنا انداز ڈھونڈیں۔ آپ مختلف قسم کے اسٹائل استعمال کرسکتے ہیں ، جیسے کہ مندرجہ ذیل مثالوں: myVariable، MyVariable، myvariable، MYVARIABLE، My_ Variable، MY_VARIABLE، my_variable، my_ariable، My_variable، and more اس بات کو یقینی بنائیں کہ آپ ہر انداز کو ایک مخصوص قسم کے لئے تفویض کرتے ہیں جیسے مستقل متغیر کے لئے MY_VARIABLE اور باقاعدگی سے متغیر کے ل my myVariable۔ بس اس بات کو یقینی بنائیں کہ آپ اسٹائل کے مطابق مستقل رہیں۔ آپ میرے متغیر اور MY_VARIABLE مستقل متغیر دونوں کو ختم نہیں کرنا چاہتے۔