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

Fungsi: rewriteComment() ​

rewriteComment(comment): void

Beta

Pindahkan setiap tag blok @demo pada komen ke dalam pagar demo yang dilampirkan pada ringkasannya, mengikut susunan. Kandungan tag blok akan digaris semula semula oleh tema markdown, jadi pagar mesti berada dalam prosa ringkasan, yang dihantar secara literal.

Parameter ​

comment ​

Comment

Komen untuk ditulis semula di tempat.

Mengembalikan ​

void

Contoh ​

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