JSDoc



jsdoc

JSDoc

ابدء

الابتداء مع JSDoc 3
بداية سريعة لتوثيق JavaScript مع JSDoc.
استخدام مسميات الاسم مع JSDoc 3
دليل لاستخدام مسميات الاسم مع JSDoc 3.
وسيطات سطر الأوامر إلى JSDoc
حول وسيطات سطر الأوامر إلى JSDoc.
تكوين JSDoc مع ملف تكوين
كيفية تكوين JSDoc باستخدام ملف التكوين.
تكوين القالب الافتراضي لـ JSDoc
كيفية تكوين الإخراج من القالب الافتراضي لـ JSDoc.
منع وبطاقات مضمنة
نظرة عامة على علامات JSDoc المضمنة والمضمنة.
حول JSDoc الإضافات
كيفية إنشاء واستخدام ملحقات JSDoc.
باستخدام البرنامج المساعد Markdown
تمكين دعم Markdown في JSDoc.
Tutorials
إضافة برامج تعليمية إلى وثائق API الخاصة بك.
بما في ذلك ملف الحزمة
كيفية إظهار تفاصيل الحزمة في وثائقك.
بما في ذلك ملف README
كيفية تضمين ملف README في الوثائق الخاصة بك.
License
معلومات الترخيص لـ JSDoc 3.

أمثلة JSDoc

ES 2015 فصول
كيفية إضافة تعليقات JSDoc إلى دروس ECMAScript 2015.
ES 2015 الوحدات
كيفية إضافة تعليقات JSDoc إلى وحدات ECMAScript 2015.
وحدات CommonJS
كيفية إضافة تعليقات JSDoc إلى الوحدات النمطية CommonJS و Node.js.
وحدات AMD
كيفية إضافة تعليقات JSDoc إلى وحدات AMD و RequireJS.

حظر العلامات

@abstract (مرادفات:virtual)
يجب أن يتم تنفيذ هذا العضو (أو تجاوزه) بواسطة الوريث.
@access
حدد مستوى الوصول لهذا العضو (خاص أو حزمة خاصة أو عامة أو محمية).
@alias
عامل العضو كما لو كان له اسم مختلف.
@async
تشير إلى أن وظيفة غير متزامن.
@augments (المرادفات:extends)
تشير إلى أن رمزًا يرمز إلى رمز أصل ، ويضيف إليه.
@author
التعرف على مؤلف العنصر.
@borrows
يستخدم هذا الكائن شيء من كائن آخر.
@callback
وثيقة وظيفة رد اتصال.
@class (المرادفات: @ Constructor)
تهدف هذه الوظيفة إلى أن يتم استدعاء الكلمة الأساسية "الجديدة".
@classdesc
استخدم النص التالي لوصف الفصل بالكامل.
@constant (المرادفات:const)
قم بتوثيق كائن كثاني.
@constructs
سيكون عضو الدالة هذا هو منشئ للفئة السابقة.
@copyright
توثيق بعض معلومات حقوق النشر.
@default (مرادفات:defaultvalue)
توثيق القيمة الافتراضية.
@deprecated
وثق بأن هذه لم تعد الطريقة المفضلة.
@description (المرادفات:desc)
وصف رمز.
@enum
توثيق مجموعة من الخصائص ذات الصلة.
@event
توثيق حدث.
@example
قدّم مثالاً لكيفية استخدام عنصر موثق.
@exports
حدد العضو الذي يتم تصديره بواسطة وحدة JavaScript.
@external (المرادفات:host)
يحدد فئة خارجية أو مساحة اسم أو وحدة نمطية.
@file (المرادفات:fileoverview ،overview)
وصف ملف.
@fires (المرادفات:emits)
صف الأحداث التي قد تطلقها هذه الطريقة.
@function (مرادفات:func ، @ method)
وصف وظيفة أو طريقة.
@generator
تشير إلى أن الوظيفة هي وظيفة مولد.
@global
وثيقة كائن عالمي.
@hideconstructor
تشير إلى أنه لا يجب عرض المُنشئ.
@ignore
احذف رمزًا من الوثائق.
@implements
يقوم هذا الرمز بتنفيذ واجهة.
@inheritdoc
تشير إلى أن الرمز يجب أن يرث وثائق الأصل الخاص به.
@inner
وثيقة كائن داخلي.
@instance
وثيقة عضو مثيل.
@interface
هذا الرمز هو واجهة يمكن للآخرين تنفيذها.
@kind
أي نوع من الرموز هو هذا؟
@lends
خصائص المستند على كائن حرفي كما لو كان ينتمي إلى رمز باسم معين.
@license
حدد الترخيص الذي ينطبق على هذا الرمز.
@listens
قائمة الأحداث التي يستمع رمز ل.
@member (المرادفات:var)
وثيقة عضو.
@memberof
ينتمي هذا الرمز إلى رمز أصل.
@mixes
يخلط هذا الكائن في جميع الأعضاء من كائن آخر.
@mixin
وثيقة كائن mixin.
@module
قم بتوثيق وحدة JavaScript.
@name
توثيق اسم كائن.
@namespace
وثيقة كائن مساحة اسم.
@override
تشير إلى أن رمز يتجاوز أصلها.
@package
هذا الرمز يعني أن تكون حزمة خاصة.
param (مرادفات:arg ،argument)
توثيق المعلمة إلى وظيفة.
@private
هذا الرمز مخصص ليكون خاص.
@property (المرادفات:prop)
قم بتوثيق خاصية كائن.
@protected
هذا الرمز هو أن تكون محمية.
@public
هذا الرمز مخصص للجمهور.
@readonly
هذا الرمز مخصص للقراءة فقط.
@requires
يتطلب هذا الملف وحدة JavaScript.
@returns (المرادفات:return)
توثيق قيمة الإرجاع للدالة.
@see
الرجوع إلى بعض الوثائق الأخرى لمزيد من المعلومات.
@since
متى تمت إضافة هذه الميزة؟
@static
وثيقة عضو ثابت.
@summary
نسخة أقصر من الوصف الكامل.
@this
ما الذي تشير إليه كلمة "هذه" هنا؟
@throws (المرادفات:exception)
وصف الأخطاء التي يمكن رميها.
@todo
مهام المستندات يجب إكمالها.
@tutorial
أدخل رابطًا لملف تعليمي مضمن.
@type
توثيق نوع الكائن.
@typedef
قم بتوثيق نوع مخصص.
@variation
تمييز الأشياء المختلفة بنفس الاسم.
@version
وثائق رقم إصدار عنصر.
@yields (المرادفات:yield)
توثيق القيمة التي تم الحصول عليها بواسطة وظيفة المولد.

علامات مضمنة

{@link} (المرادفات: {linkcode} ، {@ linkplain})
وصلة إلى عنصر آخر في الوثائق.
{@tutorial}
رابط إلى البرنامج التعليمي.

تساهم

مشروع JSDoc على جيثب
ساهم في JSDoc.
استخدم مشروع JSDoc على GitHub
ساهم في وثائق JSDoc.

شراك لي على جيثب