pantoken / plugins/typedoc/demo/src / rewriteComment

دالة: rewriteComment() ​

rewriteComment(comment): void

بيتا

نقل كل وسم كتلة @demo في التعليق إلى سياجات demo المرفقة بملخصه، بالترتيب. يُعاد تأطير محتوى وسم الكتلة بواسطة قالب الماركداون، لذلك يجب أن توجد السياج داخل نص الملخص، الذي يُصدر كما هو.

المعلمات ​

comment ​

Comment

التعليق لإعادة كتابته في الموضع.

القيم المرجعة ​

void

مثال ​

ts
import { rewriteComment } from "@pantoken/typedoc-plugin-demo";

// Given a comment with `@demo self:button`, appends a ```demo``` fence and drops the tag.
rewriteComment(comment);