پرل ماڈیولس کے لئے دستاویزات ایک عام مارک اپ زبان میں لکھی گئی ہیں جسے پی او ڈی (سادہ پرانا دستاویزات) کہا جاتا ہے۔
یہ صفحہ پرل ماڈیول کے لئے پی او ڈی لکھنے کا طریقہ دکھاتا ہے۔ اگر آپ اس طرز پر قائم رہتے ہیں تو ، پھر دوسروں کے ل your آپ کی دستاویزات کو پڑھنے اور سمجھنے میں آسانی ہوگی۔
h2xs .PM فائل کے اختتام پر ایک کنکال پی او ڈی رکھتا ہے جو لکھتا ہے۔ اضافی مثالوں کے لئے موجودہ ماڈیولز میں پی او ڈی پڑھیں۔
| =head1 NAME Geometry::Circle – manages a circle | نام سیکشن ماڈیول کا نام اور ایک سطر کی تفصیل دیتا ہے۔ نام اور تفصیل ڈیش کے ذریعہ الگ کردی گئی ہے۔ اس فارمیٹ پر قائم رہنا ضروری ہے تاکہ پی او ڈی کو مناسب مین پیج میں تبدیل کیا جاسکے۔ |
| =head1 SYNOPSIS use Geometry::Circle $circle = new Geometry::Circle $x, $y, $r ($x, $y) = $circle->center; $radius = $circle->radius; $area = $circle->area $pi = $Geometry::Circle::PI; | SYNOPSIS سیکشن ماڈیول کے استعمال میں ضروری اقدامات ظاہر کرتا ہے: استعمال کا بیان ، کوئی subroutines ، کلاس طریقوں یا متغیرات ، اور تمام آبجیکٹ کے طریقے۔ میتھڈ کالز میں ان کے پیرامیٹرز اور ریٹرن ویلیوز کی نشاندہی کرنی چاہئے۔ اختصار میں ہر لائن کو انڈین کریں۔ اس سے یہ ایک لفظی پیراگراف بن جاتا ہے ، اور یہ یقینی بناتا ہے کہ آپ کی صف بندی محفوظ رہے گی۔ |
| =head1 REQUIRES Perl5.8.8, Exporter, Geometry::Point | مطلوبہ سیکشن صارف کو بتاتا ہے کہ ان کو ماڈیول کے استعمال کے ل what کیا ضرورت ہوگی۔ |
| =head1 EXPORTS Nothing | ایکسپورٹ سیکشن صارف کو بتاتا ہے کہ اگر وہ ماڈیول استعمال کریں تو ان کے نام کی جگہ کا کیا کریں گے۔ |
| =head1 DESCRIPTION Geometry::Circle manages circles. Methods are provided for creating circles and computing their areas. | یہ ماڈیول کی تفصیل ہے۔ اس میں پروگرامر کی بجائے صارف کے لئے متعلقہ الفاظ میں لکھا جانا چاہئے۔ یہ صارف کے لئے کیا کرتا ہے؟ آپ اسے کس طرح استعمال کریں گے؟ کون سی چیزوں کی تائید کرتا ہے؟ کون کون سے طریقوں سے یہ کام کرتا ہے؟ فراہم کرتے ہیں؟ |
| =head1 METHODS =head2 Creation =over 4 =item new Geometry::Circle $x, $y, $radius Creates and returns a new Geometry::Circle object with center ($x, $y) and radius $radius. =back =head2 Access =over 4 =item $circle->center Returns a list of the x,y coordinates of the center of the circle. In scalar context, returns an array reference. =item $circle->radius Returns the radius of the circle. =item $circle->area Returns the area of the circle. =back | میتھوڈس سیکشن کلاس میں ہر طریقہ کی فہرست اور وضاحت کرتا ہے۔ آپ مزید درجے کے عنوانات کے تحت ایسے طریقے ترتیب دے سکتے ہیں ، جیسے تخلیق ، رسائی اور افادیت۔ |
| =head1 CLASS VARIABLES =over 4 =item $Geometry::Circle::PI The ratio of the circumference of a circle to its diameter. =back | کلاس متغیرات کا سیکشن API میں کسی بھی پیکیج کے متغیر کی فہرست رکھتا ہے۔ |
| =head1 DIAGNOSTICS =over 4 =item Negative radius (F) A circle may not be created with a negative radius. =back | ڈائیگناسٹکس سیکشن ہر خرابی پیغام کا متن دیتا ہے جس سے ماڈیول تیار کیا جاسکتا ہے ، اور اس کے معنی کی وضاحت کرتا ہے۔ غلط پیغامات کو درج ذیل میں درجہ بندی کیا جاتا ہے: (ڈبلیو) انتباہ (اختیاری) (ڈی) ایک فرسودگی (اختیاری) (ایس) ایک سخت انتباہ (لازمی) (F) ایک مہلک خرابی (trappable) (X) ایک بہت ہی مہلک خرابی (ناقابل تلافی) |
| =head1 AUTHOR A. U. Thor, [email protected] | اگر آپ کو ماڈیول کے سلسلے میں کسی سے رابطہ کرنے کی ضرورت ہو تو آپ کو اپنا نام اور ای میل پتہ شامل کرنا چاہئے۔ |
| =head1 SEE ALSO perl(1), Geometry::Square | یہ متعلقہ پروگراموں اور ماڈیولز کی معمول کی فہرست ہے۔ |
| =cut | کٹ لائن پی او ڈی ٹیکسٹ کا اختتام کرتی ہے۔ کچھ لوگ اپنے سورس کوڈ میں پی او ڈی سیکشن تقسیم کرتے ہیں۔ پرل پی او ڈی سیکشن کو پہچانتا ہے اور ان کو نظرانداز کرتا ہے۔ |