JSDoc
جے ایس ڈی او سی ایک مارک اپ زبان ہے جو جاوا اسکرپٹ سورس کوڈ فائلوں کی تشریح کے لیے استعمال ہوتی ہے۔ جے ایس ڈی او سی پر مشتمل تبصرے کا استعمال کرتے ہوئے، پروگرامر اپنے بنائے ہوئے کوڈ کے ایپلیکیشن پروگرامنگ انٹرفیس کو بیان کرنے والی دستاویزات شامل کر سکتے ہیں۔ اس کے بعد ایچ ٹی ایم ایل اور رچ ٹیکسٹ فارمیٹ جیسے قابل رسائی فارمیٹس میں دستاویزات تیار کرنے کے لیے مختلف ٹولز کے ذریعے اس پر کارروائی کی جاتی ہے۔ جے ایس ڈی او سی کی تفصیلات سی سی بائی-ایس اے 3 کے تحت جاری کی گئی ہیں، جبکہ اس کا ساتھی دستاویزات جنریٹر اور پارسر لائبریری اپاچی لائسنس 2 کے تحت مفت سافٹ ویئر ہے۔ جے ایس ڈی او سی کا نحو اور الفاظ جاواڈوک اسکیم سے ملتے جلتے ہیں، جو جاوا میں لکھے گئے کوڈ کو دستاویزی شکل دینے کے لیے استعمال ہوتا ہے۔ جے ایس ڈی او سی جاواڈوک سے مختلف ہے، اس لحاظ سے کہ یہ جاوا اسکرپٹ کے متحرک رویے کو سنبھالنے میں مہارت رکھتا ہے۔ جاوا اسکرپٹ کو دستاویز کرنے کے لیے جاواڈوک جیسے نحو کا استعمال کرتے ہوئے ایک ابتدائی مثال 1999 میں نیٹ اسکیپ/موزیلا پروجیکٹ رائنو کے ساتھ جاری کی گئی تھی، جو جاوا میں لکھا گیا جاوا اسکرپٹ رن ٹائم سسٹم ہے۔ اس میں ایک کھلونا "جے ایس ڈی او سی" ایچ ٹی ایم ایل جنریٹر شامل تھا، جو اس کی جاوا اسکرپٹ صلاحیتوں کی مثال کے طور پر 1.3 تک ورژن کیا گیا تھا۔ "جے ایس ڈی او سی" کی تمام اہم نسلوں کی سربراہی مائیک میتھس (مائیکل میتھیوز) کر رہے تھے۔ انہوں نے 2001 میں JSDoc.pm کے ساتھ آغاز کیا، جو کہ کینیڈا کے پروگرامر گیبریل ریڈ کے تعاون سے پرل میں لکھا گیا ایک سادہ نظام ہے۔ اسے سی وی ایس کے ذخیرے میں سورس فورج پر ہوسٹ کیا گیا تھا۔ جے ایس ڈی او سی 1 (2007) کے ذریعے اس نے سسٹم کو جاوا اسکرپٹ (دوبارہ رائنو کے لیے) میں دوبارہ لکھا، اور توسیع کے ایک سیٹ کے بعد جے ایس ڈی او سی 2 (2008) نے "جے ایس ڈی او سی-ٹول کٹ" کا نام حاصل کیا۔ ایم آئی ٹی لائسنس کے تحت جاری کیا گیا، اسے گوگل کوڈ پر سبورژن ریپوزیٹری میں ہوسٹ کیا گیا تھا۔ 2011 تک انہوں نے سسٹم کو جے ایس ڈی او سی 3 میں تبدیل کر دیا اور گٹ ہب پر نتیجہ کی میزبانی کی۔ یہ اب Node.js پر چلتا ہے۔ جے ایس ڈی او سی ٹیگز جدید جے ایس ڈی او سی میں استعمال ہونے والے کچھ زیادہ مقبول اینوٹیشن ٹیگز یہ ہیں: {| کلاس = "وکیٹیبل"! ٹیگ! ! تفصیل۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔۔ |-| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | */کلاس سرکل {/* * * سرکل کی ایک مثال بناتا ہے۔ * * @author: moi * @param {نمبر} r دائرے کا مطلوبہ رداس۔ */کنسٹرکٹر (r) {/* * @private */this.radius = r/* @private */this.circumference = 2 * Math.PI * r}/* * * قطر سے ایک نیا دائرہ بناتا ہے۔ * * @param {نمبر} d دائرے کا مطلوبہ قطر۔ @return {سرکل} نیا سرکل آبجیکٹ۔ */جامد سے قطر (d) {نیا دائرہ واپس کریں (d/2)}/* * * دائرے کے دائرے کا حساب لگاتا ہے۔ * * @deprecated 1.1.0 سے ؛ دائرے کے دائرے کے بجائے * @return {نمبر} کا استعمال کریں۔ سرکمفرینس () {ریٹرن 2 * Math.PI * this.radius}/* * * دائرے کا پہلے سے شمار شدہ دائرہ واپس کرتا ہے۔ * * @return {نمبر} دائرے کا دائرہ۔ * @since 1.1.0 */حاصل کریں سرکمفرینس () {واپسی this.circumference}/* * * دائرے کی سٹرنگ نمائندگی تلاش کریں۔ * * @override * @return {سٹرنگ} اس دائرے کی قابل مطالعہ انسانی نمائندگی۔ */سے سٹرنگ () {واپسی '[${this.radius} کے رداس کے ساتھ ایک سرکل آبجیکٹ۔ ] '}}/* * * ایک دائرے کو چھاپتا ہے۔ * * @param {سرکل} سرکل */فنکشن پرنٹ سرکل (سرکل) {/* * @this {سرکل} */فنکشن باؤنڈ () {console.log (یہ)} bound.apply (سرکل)} نوٹ کریں کہ حقیقت میں ٹیگز کو خارج کیا جا سکتا ہے: ای سی ایم اے سنٹیکس ان کی شناخت کو واضح کرنے کے لیے کافی ہے، اور جے ایس ڈی او سی اس کا استعمال کرتا ہے۔ خود کار طریقے سے بھی اخذ کیا جا سکتا ہے۔ جے ایس ڈی او سی گوگل کا کلوزر لنٹر اور کلوزر کمپائلر استعمال کرتا ہے۔ مؤخر الذکر اپنی آؤٹ پٹ جاوا اسکرپٹ کو بہتر بنانے کے لیے ٹائپ کی معلومات نکالتا ہے۔ ٹائپ اسکرپٹ جے ایس ڈی او سی قسم کی تشریحات کے ساتھ جاوا اسکرپٹ فائلوں کے لیے ٹائپ چیکنگ انجام دے سکتا ہے۔ مائیکروسافٹ نے ایکسٹینسیبل ٹیگز کے ساتھ ایک نئی ٹی ایس ڈی او سی زبان متعین کی ہے۔ مقبول ایڈیٹر سب لائم ٹیکسٹ ڈاک بلاکر یا ڈاکسی ڈاکسجن پلگ ان کے ذریعے جے ایس ڈی او سی کی حمایت کرتا ہے۔ جے ایس ڈی او سی نحو کو ایپریس بک فاؤنڈیشنز آف ایجیکس میں تفصیل سے بیان کیا گیا ہے۔ انٹیلی جے آئی ڈی ای اے، نیٹ بینز، ویژول اسٹوڈیو کوڈ اور روبی مائن جے ایس ڈی او سی نحو کو سمجھتے ہیں۔ ایکلپس پر مبنی اپٹانا اسٹوڈیو اسکرپٹ ڈاک کو سپورٹ کرتا ہے۔ موزیلا، موزیلا ان لائن ایڈیٹر JSDoc.pm استعمال کرتا ہے۔ ہیلما ایپلیکیشن فریم ورک جے ایس ڈی او سی کا استعمال کرتا ہے۔ اسپراؤٹ کور دستاویزات جے ایس ڈی او سی کا استعمال کرتے ہوئے تیار کی گئی تھیں۔ بصری اسٹوڈیو، ویب اسٹورم اور بہت سے دوسرے مربوط ترقیاتی ماحول یا ٹیکسٹ ایڈیٹرز جے ایس ڈی او سی تبصروں کی بنیاد پر کوڈ تکمیل اور دیگر مدد پیش کرتے ہیں۔ اوپن سورس ایٹم ایڈیٹر ایٹم-ایزی-جے ایس ڈی او سی پلگ ان کے ذریعے جے ایس ڈی او سی کی حمایت کرتا ہے۔ دستاویزات جنریٹرز کا موازنہ بھی دیکھیں گوگل کلوزر ٹولز حوالہ جات بیرونی لنکس مفت دستاویزات جنریٹرز جاوا اسکرپٹ پروگرامنگ ٹولز