توثيق عودة منشئ JavaScript مع JSDoc

Question

لدي وظيفة JavaScript التي ترجع منشئ (انظر نموذج التعليمات البرمجية أدناه).كيف يمكنني توثيق هذا مع علامة @ returns of jsdoc.لا يبدو صحيحا للقيام @ @ myconstructor} لأن ذلك يعني أنني أعود إلى مثيل "myconstressor" بدلا من المنشئ نفسه، أليس كذلك؟

giveacodicetagpre.

Answer 1

يمكنك التحقق من الأنواع التي تم إرجاعها بواسطة وظائفك باستخدام:

giveacodicetagpre.

في الوثائق تقول:

giveacodicetagpre.

http://usejsdoc.org/tags-returns.html

لذلك في مثال سيكون:

giveacodicetagpre.

أو إذا كنت تقوم بإنشاء مثيل عنصر:

giveacodicetagpre.

Answer 2

لا أعتقد أن هناك طريقة لاستخدام الأقواس بعد @returns للوثيقة التي ترجع محددة محددة.يتم تفسير ما يحدث في الأقواس على أنه نوع ، دائما.ومع ذلك، هناك طريقة للوثيقة التي يتم بها إرجاع مثيل معين للنوع، عن طريق توثيق المثيل واستخدام رابط إلى المثيل.لقد قمت بتقصير الرمز في السؤال إلى الأساسيات اللازمة لتوضيح:

giveacodicetagpre.

يمكن القيام به أيضا بأشياء أخرى من الفصول:

giveacodicetagpre.

بقدر ما أعرف، هذا جيد كما يحصل مع JSDoc 3.

Answer 3

ربما متأخرة قليلا، لكن لدي مشكلة في العثور على إجابة مناسبة لحدث سؤالك اليوم.

عندما أحاول إنشاء jsdoc تلقائيا على العاصفة عبر الإنترنت، فهذا ما أحصل عليه:

giveacodicetagpre.

يعين تعريف نوع الإرجاع غريبا، ولكن قد يفي التوضيح بالبناء الغرض.