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

Fungsi: rewriteComment() ​

rewriteComment(comment): void

Beta

Tempatkan setiap tag blok @demo pada sebuah komentar ke dalam pagar demo yang ditambahkan ke ringkasannya, secara berurutan. Konten tag blok akan diformat ulang oleh tema markdown, jadi pagar harus berada dalam prosa ringkasan, yang diterbitkan apa adanya.

Parameter ​

comment ​

Comment

Komentar yang akan ditulis ulang 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);