Javadoc
جاواڈوک ایک دستاویزی جنریٹر ہے جسے سن مائیکرو سسٹمز نے جاوا زبان (جو اب اوریکل کارپوریشن کی ملکیت ہے) کے لیے جاوا سورس کوڈ سے ایچ ٹی ایم ایل فارمیٹ میں اے پی آئی دستاویزات تیار کرنے کے لیے بنایا ہے۔ ایچ ٹی ایم ایل فارمیٹ کا استعمال متعلقہ دستاویزات کو ایک ساتھ ہائپر لنک کرنے کی سہولت کو شامل کرنے کے لیے کیا جاتا ہے۔ جاواڈوک کے ذریعہ استعمال کیا جانے والا "ڈاک کمنٹس" فارمیٹ جاوا کلاسوں کو دستاویزی شکل دینے کے لیے ڈی فیکٹو انڈسٹری کا معیار ہے۔ کچھ آئی ڈی ای، جیسے انٹیلی جے آئی ڈی ای اے، نیٹ بینز اور ایکلپس، خود بخود جاواڈوک ٹیمپلیٹس تیار کرتے ہیں۔ بہت سے فائل ایڈیٹرز جاواڈوک ماخذ تیار کرنے میں صارف کی مدد کرتے ہیں اور پروگرامر کے لیے اندرونی حوالوں کے طور پر جاواڈوک کی معلومات کا استعمال کرتے ہیں۔ جاواڈوک ڈاکلیٹ اور ٹیگلیٹ بنانے کے لیے ایک اے پی آئی بھی فراہم کرتا ہے، جو صارفین کو جاوا ایپلی کیشن کے ڈھانچے کا تجزیہ کرنے کی اجازت دیتا ہے۔ اس طرح جے ڈیف ایک اے پی آئی کے دو ورژن کے درمیان کیا تبدیل ہوا اس کی رپورٹیں تیار کر سکتا ہے۔ جاواڈوک جاوا میں کارکردگی کو متاثر نہیں کرتا ہے کیونکہ تمام تبصرے تالیف کے وقت ہٹا دیے جاتے ہیں۔ تبصرے لکھنا اور جاواڈوک کوڈ کو بہتر طور پر سمجھنے اور اس طرح اسے بہتر طریقے سے برقرار رکھنے کے لیے ہے۔ تاریخ جاواڈوک جاوا زبان کا ابتدائی دستاویزات پیدا کرنے والا تھا۔ دستاویزات جنریٹرز کے استعمال سے پہلے تکنیکی مصنفین کا استعمال کرنے کا رواج تھا جو عام طور پر سافٹ ویئر کے لیے صرف اسٹینڈ لون دستاویزات لکھتے تھے، لیکن اس دستاویزات کو خود سافٹ ویئر کے ساتھ ہم آہنگ رکھنا بہت مشکل تھا۔ جاواڈوک کو جاوا نے پہلی ریلیز کے بعد سے استعمال کیا ہے، اور عام طور پر جاوا ڈویلپمنٹ کٹ کی ہر نئی ریلیز پر اپ ڈیٹ کیا جاتا ہے۔ جاواڈوک کے @field نحو کو دیگر زبانوں کے دستاویزات کے نظام کے ذریعے نقل کیا گیا ہے، بشمول کراس لینگویج ڈاکسجن، جاوا اسکرپٹ کے لیے جے ایس ڈی او سی سسٹم، اور ایپل کا ہیڈر ڈاک۔ تکنیکی فن تعمیر جاواڈوک تبصرے کی ساخت ایک جاواڈوک تبصرہ کو معیاری ملٹی لائن کمنٹ ٹیگز/* اور */کے ذریعے کوڈ سے الگ کیا جاتا ہے۔ افتتاحی ٹیگ (جسے اسٹارٹ کمنٹ ڈیلیمیٹر کہا جاتا ہے) میں ایک اضافی ستارہ ہوتا ہے، جیسا کہ/* * میں ہوتا ہے۔ پہلا پیراگراف دستاویز شدہ طریقہ کار کی وضاحت ہے۔ تفصیل کے بعد وضاحتی ٹیگز کی مختلف تعداد ہوتی ہے، جس سے یہ ظاہر ہوتا ہے کہ: طریقہ کار کے پیرامیٹرز (@param) طریقہ کیا واپس کرتا ہے (@return) کوئی مستثنیات جو طریقہ پھینک سکتا ہے (@throws) دیگر کم عام ٹیگز جیسے @see (a "یہ بھی دیکھیں" ٹیگ) جاواڈوک کا جائزہ دستاویز کے تبصرے لکھنے کا بنیادی ڈھانچہ انہیں اندر سرایت کرنا ہے۔ جاواڈوک کمنٹ بلاک بغیر کسی علیحدہ نئی لائن کے آئٹمز کے بالکل اوپر رکھا گیا ہے۔ نوٹ کریں کہ کسی بھی درآمدی بیان کو کلاس ڈیکلریشن سے پہلے ہونا چاہیے۔ کلاس ڈیکلریشن میں عام طور پر:// درآمد بیانات/* * * @author پہلا نام آخری نام <ایڈریس @example.com> * @version 1.6 (پروگرام کا موجودہ ورژن نمبر) * @since 1.2 (پیکیج کا ورژن جس میں اس کلاس کو پہلی بار شامل کیا گیا تھا) */پبلک کلاس ٹیسٹ [// کلاس باڈی] طریقوں کے لیے (1) ایک مختصر، جامع، ایک لائن کی تفصیل ہوتی ہے تاکہ یہ وضاحت کی جا سکے کہ آئٹم کیا کرتا ہے۔ اس کے بعد (2) ایک لمبی تفصیل ہے جو متعدد پیراگراف پر محیط ہو سکتی ہے۔ تفصیلات یہاں مکمل طور پر بیان کی جا سکتی ہیں۔ یہ سیکشن اختیاری ہے۔ آخر میں، طریقہ کار کے قبول شدہ ان پٹ دلائل اور ریٹرن ویلیوز کی فہرست بنانے کے لیے (3) ایک ٹیگ سیکشن ہے۔ نوٹ کریں کہ تمام جاواڈوک کو ایچ ٹی ایم ایل کے طور پر سمجھا جاتا ہے لہذا متعدد پیراگراف کے حصوں کو "<p>" پیراگراف بریک ٹیگ سے الگ کیا جاتا ہے۔ / * * * ایک سطر کی مختصر تفصیل۔ (1) * <p> * لمبی تفصیل۔ اگر کوئی ہوتا تو یہ یہاں (2) * ہوتا۔ * <p> * اور اس سے بھی زیادہ وضاحتیں مسلسل * پیراگراف میں ایچ ٹی ایم ایل پیراگراف کے وقفوں سے الگ ہیں۔ * * @param متغیر تفصیل متن متن۔ (3) * @return تفصیل متن متن۔ */پبلک انٹ میتھڈ نام (.) {// ریٹرن سٹیٹمنٹ کے ساتھ میتھڈ باڈی} متغیرات کو طریقوں کی طرح دستاویز کیا جاتا ہے سوائے اس کے کہ حصہ (3) کو خارج کر دیا گیا ہے۔ یہاں متغیر میں صرف مختصر تفصیل شامل ہے:/* * * یہاں متغیر کی تفصیل۔ */پرائیویٹ انٹ ڈیبگ = 0 ؛ نوٹ کریں کہ ایک ہی دستاویزات کے تبصرے میں متعدد متغیرات کی وضاحت کرنے کی سفارش نہیں کی جاتی ہے۔ اس کی وجہ یہ ہے کہ جاواڈوک ہر متغیر کو پڑھتا ہے اور انہیں اسی دستاویزات کے تبصرے کے ساتھ تیار کردہ ایچ ٹی ایم ایل پیج پر الگ سے رکھتا ہے جو تمام شعبوں کے لیے نقل کیا جاتا ہے۔ / * * * نقطہ (x، y) */عوامی int x، y ؛// AVOID کے افقی اور عمودی فاصلے اس کے بجائے، ہر متغیر کو الگ الگ لکھنے اور دستاویز کرنے کی سفارش کی جاتی ہے:/* * * نقطہ کا افقی فاصلہ۔ */عوامی int x ؛/* * * نقطہ کا عمودی فاصلہ۔ */پبلک انٹ وائی ؛ ٹیبل آف جاواڈوک ٹیگز کچھ دستیاب جاواڈوک ٹیگز نیچے دیے گئے ٹیبل میں درج ہیں: مثالیں طریقہ کار کو دستاویز کرنے کے لیے جاواڈوک کی ایک مثال درج ذیل ہے۔ نوٹ کریں کہ اس مثال میں فرق اور حروف کی تعداد جیسا کہ کنونشن بیان کرتے ہیں۔ / * * * شطرنج کی حرکت کی توثیق کرتا ہے۔ * * <p> کسی ٹکڑے کو منتقل کرنے کے لیے {@link #doMove (فائل سے int، رینک سے int، فائل سے int، رینک سے int)} کا استعمال کریں۔ * * @param فائل فائل سے جس سے ایک ٹکڑا منتقل کیا جا رہا ہے * @param رینک رینک سے جہاں سے ایک ٹکڑا منتقل کیا جا رہا ہے * @param سے فائل فائل میں جہاں ایک ٹکڑا منتقل کیا جا رہا ہے * @param سے رینک رینک جس میں ایک ٹکڑا منتقل کیا جا رہا ہے * @return درست ہے اگر حرکت درست ہے، بصورت دیگر غلط * @since 1.0 */بولین ویلڈ موو ہے (فائل سے انٹی، رینک سے انٹی، فائل سے فائل، انٹی ٹو رینک) {//. باڈی]/* * شطرنج کے ٹکڑے کو منتقل کرتا ہے۔ Doclets Doclet پروگرام جاوا میں لکھے گئے کوڈ سے دستاویزات تیار کرنے کے لیے جاواڈوک ٹول کے ساتھ کام کرتے ہیں۔ ڈاکلیٹ جاوا پروگرامنگ زبان میں لکھے جاتے ہیں اور اس کا استعمال کرتے ہیں: منتخب کریں کہ دستاویزات میں کون سا مواد شامل کرنا ہے فارمیٹ مواد کی پیشکش دستاویز پر مشتمل فائل بنائیں جاواڈوک کے ساتھ شامل اے پی آئی دستاویزات کو فریم پر مبنی ایچ ٹی ایم ایل فائلوں کے طور پر تیار کرتا ہے۔ بہت سے غیر معیاری ڈاکلیٹ ویب پر دستیاب ہیں، اکثر مفت میں۔ ان کا استعمال اس طرح کیا جا سکتا ہے: دستاویزات کی دیگر غیر اے پی آئی اقسام بنائیں دستاویزات کو دیگر غیر ایچ ٹی ایم ایل فائل کی اقسام جیسے پی ڈی ایف میں ڈالیں دستاویزات کو ایچ ٹی ایم ایل کے طور پر اضافی خصوصیات کے ساتھ جیسے تلاش یا جاوا کلاسوں سے تیار کردہ سرایت شدہ یو ایم ایل خاکے کے ساتھ ڈالیں دستاویزات جنریٹرز کا موازنہ بھی دیکھیں۔ نیٹ ایکس ایم ایل دستاویزات کے تبصرے حوالہ جات بیرونی لنکس جاوا پلیٹ فارم، اسٹینڈرڈ ایڈیشن جاواڈوک گائیڈ جے ایس آر 260 جاواڈوک ٹیگ ٹیکنالوجی اپ ڈیٹ جاوا تفصیلات کی درخواست (نئے جاواڈوک ٹیگز کی وضاحت کرتا ہے) ایشکلون کے ساتھ جاواڈوک کو بہتر بنائیں مختلف جاوا دستاویزات کو ونڈوز ہیلپ فارمیٹ فری دستاویزات جنریٹرز جاوا ڈویلپمنٹ ٹولز میں تبدیل کیا گیا۔