NumPy Docstring

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

فنکشنز کے ساتھ docstrings استعمال کرتے وقت، ہمیں آرگیومینٹس پاس کرنا ہوں گے۔ کلاسوں کے ساتھ ان کا استعمال کرتے وقت، ہم صفات اور طریقوں کو پاس کرتے ہیں۔ ماڈیولز کے معاملے میں، ہمیں کلاسز اور فنکشنز کی فہرست فراہم کرنی ہوگی۔ پیکیج کے معاملے میں، ہم فعالیت کے ساتھ ماڈیولز کی فہرست پاس کرتے ہیں۔ تو بنیادی طور پر، docstring کا مقصد ہے، جیسا کہ نام بتاتا ہے، کہ یہ ہمارے کوڈ کی دستاویزات میں مدد کرتا ہے۔ ہم ڈاکومنٹیشن اس لیے کرتے ہیں کہ اگر کوئی مستقبل میں ہمارا کوڈ استعمال کرتا ہے تو وہ docstring کی مدد سے ہمارے کوڈ اور ہمارے کوڈ کے پیچھے کی منطق کو سمجھ سکے۔ بلٹ ان فنکشنز میں بھی docstrings ہوتے ہیں۔ ہم مدد() کے فنکشن کو بلٹ ان فنکشنز کی دستاویز کو دیکھنے کے لیے استعمال کر سکتے ہیں۔

تبصرے اور docstrings کے درمیان کچھ فرق ہیں۔ تبصروں کو ترجمانوں کے ذریعہ نظر انداز کیا جاتا ہے لیکن docstrings کو ترجمانوں کے ذریعہ نظر انداز نہیں کیا جاتا ہے۔ میموری کو docstrings کے لیے مختص کیا گیا ہے۔ ایک تبصرہ کوڈ کی وضاحت ہے لیکن دوسری طرف، docstrings ہمیں کوڈ کا مقصد بتاتا ہے۔

نحو:

NumPy میں docstrings لکھنے کا نحو یہ ہے:

براہ کرم نوٹ کریں کہ docstring کوئی فنکشن یا طریقہ نہیں ہے، لہذا اس میں مناسب نحو نہیں ہے۔ یہاں صرف ایک بات نوٹ کرنے کی ہے کہ ہم docstring کو تین سنگل کوٹس یا تین ڈبل کوٹس سے شروع کرتے ہیں۔ ہم اپنے کوڈ کی تفصیل لکھتے ہیں اور اسے تین سنگل اقتباسات یا آخر میں تین ڈبل اقتباسات کے ساتھ دوبارہ ختم کرتے ہیں۔ docstrings کے لیے لکھنے کے لیے کوئی لازمی چیز نہیں ہے۔ آپ کو اپنی سٹرنگ کی تفصیل سے پہلے اور بعد میں صرف تین سنگل یا ڈبل ​​اقتباسات ڈالنے ہوں گے۔

مثال 1:

docstrings کو بہتر طریقے سے سمجھنے کے لیے، آئیے ایک مثال پیش کرتے ہیں۔ اس مثال میں، NumPy لائبریری کو شامل کرنے کے بعد، ہم صرف متغیر 'a' اور دوسرے متغیر 'b' کا اعلان کرتے ہیں۔ اس کے بعد، ہم اپنی docstring بناتے ہیں جو کہتا ہے 'آئیے 'a' اور 'b' متغیرات کو شامل کریں'۔ ہمارے معاملے میں، یہ ایک آسان مثال ہے لیکن اگر ہمارا کوڈ پیچیدہ ہے، تو اس سے کوڈر کو کوڈ کو سمجھنے میں بہت مدد ملتی ہے۔ اس کے بعد، ہم متغیرات 'a' اور 'b' کو جمع کرتے ہیں اور ان کے آؤٹ پٹ کے نتیجے کو ایک اور متغیر میں محفوظ کرتے ہیں جو کہ 'c' ہے۔ آخر میں، ہم متغیر 'c' کی قدر پرنٹ کرتے ہیں۔ اب، ہم اپنے کوڈ پر عمل کرتے ہیں۔

یہ کوڈ کے دیئے گئے ٹکڑے سے ہماری آؤٹ پٹ ہے۔ ہم دیکھ سکتے ہیں کہ سسٹم نے ہمارے کوڈ کی لائن 7 کے لیے غلط نحو یا کسی بھی چیز کے بارے میں کوئی غلطی نہیں دی ہے۔ اس کے علاوہ، سسٹم نے ہماری دستاویز کو پرنٹ نہیں کیا ہے۔ اس کے بجائے، اس نے صرف ہمارے متغیر 'c' کا آؤٹ پٹ پرنٹ کیا جس میں ہم نے اپنے سسٹم کو پرنٹ کرنے کو کہا۔ اس سے پتہ چلتا ہے کہ docstrings کیسے کام کرتے ہیں۔ اگلی بار، جب کوئی نیا کوڈر ہمارے کوڈ پر کام کرنے کی کوشش کرے گا، تو وہ سمجھے گا کہ ہم اپنے docstring کی مدد سے کیا کر رہے ہیں۔ لیکن اسے آؤٹ پٹ کے طور پر پرنٹ نہیں کیا جائے گا تاکہ کوڈ کا صارف اس سے پریشان نہ ہو۔

مثال 2:

اب، ہم docstring کے کام کو سمجھنے کے لیے ایک پیچیدہ مثال پیش کرتے ہیں۔ سب سے پہلے، ہم NumPy لائبریری کو شامل کرتے ہیں اور پھر ایک دستاویز سٹرنگ لکھتے ہیں جس میں ہم کوڈ کی اگلی لائن کی وضاحت کرتے ہیں جہاں ہم صف کی ابتداء کی وضاحت کرتے ہیں۔ ہم کوڈ کے دوسرے حصے میں بھی docstrings شامل کرتے ہیں۔ اب، اگر ہم اس کوڈ کو کسی بھی نئے Python کے ڈویلپر کے ساتھ docstrings کو شامل کیے بغیر شیئر کرتے ہیں، تو اس کے لیے اس کوڈ کے کام اور مقصد کو جاننا کسی نہ کسی طرح مشکل ہو جائے گا۔ اسے پہلے ان افعال کے بارے میں تلاش کرنا ہوگا جو ہم استعمال کرتے ہیں۔ لیکن اگر ہم اپنے کوڈ میں ایک دستاویز کا اضافہ کرتے ہیں، تو دوسرے ڈویلپرز کے لیے فنکشنز کے بارے میں مزید مطالعہ کیے بغیر کوڈ کو سمجھنا آسان ہوگا۔ ہم کچھ حدود میں تبصرے شامل کرنے تک محدود نہیں ہیں۔ تبصرے ایک یا ایک سے زیادہ لائنوں کے ہو سکتے ہیں۔ اسے ایک کوڈ میں ایک سے زیادہ بار بھی شامل کیا جا سکتا ہے۔ پھر، NumPy کو بطور np درآمد کریں۔

جیسا کہ مندرجہ ذیل ٹکڑوں میں دکھایا گیا ہے، docstrings آؤٹ پٹ میں ظاہر نہیں ہوتے ہیں جس کا مطلب ہے کہ یہ کوڈ کی آؤٹ پٹ یا تالیف کو متاثر نہیں کرتا ہے۔ تالیف کے عمل کے دوران Docstrings کو نظر انداز کر دیا جاتا ہے۔

نتیجہ

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