4.0 KiB
اپنے کوڈ پر تبصرہ کریں
ہدایات
صاف، اچھی طرح سے دستاویزی کوڈ آپ کے پروجیکٹس کو برقرار رکھنے اور شیئر کرنے کے لیے ضروری ہے۔ اس اسائنمنٹ میں، آپ پیشہ ور ڈویلپرز کی ایک اہم عادت پر عمل کریں گے: واضح اور مددگار تبصرے لکھنا جو آپ کے کوڈ کے مقصد اور فعالیت کو بیان کریں۔
اپنے گیم فولڈر میں موجود app.js فائل کا جائزہ لیں اور اس میں تبصرے شامل کرنے اور اسے ترتیب دینے کے طریقے تلاش کریں۔ کوڈ کو قابو سے باہر ہونا بہت آسان ہے، اور یہ ایک اچھا موقع ہے کہ آپ تبصرے شامل کریں تاکہ آپ کے پاس قابلِ مطالعہ کوڈ ہو جسے آپ بعد میں استعمال کر سکیں۔
آپ کا کام شامل ہے:
- تبصرے شامل کریں جو کوڈ کے ہر بڑے حصے کی وضاحت کریں
- فنکشنز کو دستاویز کریں واضح وضاحتوں کے ساتھ کہ ان کا مقصد اور پیرامیٹرز کیا ہیں
- کوڈ کو منظم کریں منطقی بلاکس میں سیکشن ہیڈرز کے ساتھ
- غیر استعمال شدہ یا غیر ضروری کوڈ کو ہٹائیں
- متغیرات اور فنکشنز کے لیے مستقل نام دینے کے اصول استعمال کریں
معیار
| معیار | بہترین | مناسب | بہتری کی ضرورت |
|---|---|---|---|
| کوڈ کی دستاویزات | app.js کوڈ مکمل طور پر تبصرہ شدہ ہے، تمام بڑے حصوں اور فنکشنز کے لیے واضح اور مددگار وضاحتیں موجود ہیں |
app.js کوڈ مناسب طور پر تبصرہ شدہ ہے، زیادہ تر حصوں کے لیے بنیادی وضاحتیں موجود ہیں |
app.js کوڈ میں کم سے کم تبصرے ہیں اور واضح وضاحتوں کی کمی ہے |
| کوڈ کی تنظیم | کوڈ منطقی بلاکس میں منظم ہے، واضح سیکشن ہیڈرز اور مستقل ساخت کے ساتھ | کوڈ میں کچھ تنظیم ہے، بنیادی طور پر متعلقہ فعالیت کو گروپ کیا گیا ہے | کوڈ کچھ حد تک غیر منظم ہے اور سمجھنے میں مشکل ہے |
| کوڈ کا معیار | تمام متغیرات اور فنکشنز وضاحتی نام استعمال کرتے ہیں، کوئی غیر استعمال شدہ کوڈ نہیں، مستقل اصولوں پر عمل کرتا ہے | زیادہ تر کوڈ اچھے نام دینے کے اصولوں پر عمل کرتا ہے، کم سے کم غیر استعمال شدہ کوڈ موجود ہے | متغیرات کے نام غیر واضح ہیں، غیر استعمال شدہ کوڈ موجود ہے، غیر مستقل انداز |
ڈسکلیمر:
یہ دستاویز AI ترجمہ سروس Co-op Translator کا استعمال کرتے ہوئے ترجمہ کی گئی ہے۔ ہم درستگی کے لیے کوشش کرتے ہیں، لیکن براہ کرم آگاہ رہیں کہ خودکار ترجمے میں غلطیاں یا غیر درستیاں ہو سکتی ہیں۔ اصل دستاویز کو اس کی اصل زبان میں مستند ذریعہ سمجھا جانا چاہیے۔ اہم معلومات کے لیے، پیشہ ور انسانی ترجمہ کی سفارش کی جاتی ہے۔ ہم اس ترجمے کے استعمال سے پیدا ہونے والی کسی بھی غلط فہمی یا غلط تشریح کے ذمہ دار نہیں ہیں۔