pantoken-root / 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);