pantoken-root / plugins/typedoc/demo/src / rewriteComment

Hàm: rewriteComment() ​

rewriteComment(comment): void

Beta

Di chuyển mọi thẻ block @demo trên một chú thích vào các hàng rào demo được gắn vào phần tóm tắt của nó, theo thứ tự. Nội dung thẻ block sẽ được chủ đề markdown tái-đóng khung, vì vậy hàng rào phải nằm trong phần văn bản tóm tắt, được xuất ra nguyên văn.

Tham số ​

comment ​

Comment

Chú thích cần được viết lại tại chỗ.

Trả về ​

void

Ví dụ ​

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);