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