繁体   English   中英

为什么 typedoc 会忽略我的接口声明?

[英]Why does typedoc ignore my interface declaration?

type S=string|undefined;
declare global {
    export interface String {
        /**
         * returns string between borders
         * @param   borderA - left border
         * @param   borderB - right border
         * @param aIsFirst - true if borderA is first, false if is last
         * @param bIsFirst - true if borderB is first, false if is last
         */
        between(borderA:S, borderB:S, aIsFirst:boolean, bIsFirst:boolean):S;
    }
}

typedoc 命令: typedoc --out./documentation/ src/

它生成带有 HTML 的文件夹,取自 README.md,但在那里找不到我的界面的痕迹......

TypeDoc 将仅记录由您的入口点之一导出的内容。 如果您导出 Foo 而不是 IFoo,您将收到一个错误,指出它已使用“但未包含在文档中”...

https://github.com/TypeStrong/typedoc/issues/1739

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM