@internal
标签类型:修饰符
TSDoc 标准化: 可自行决定
@internal
修饰符是四个发布标签之一。它表示 API 项目仅供同一维护者的其他 NPM 包使用。第三方永远不应该使用“内部”API。为了强调这一点,在带有(显式)@internal
标签的声明的名称中应该使用下划线前缀。API 提取器验证此命名约定,如果缺少下划线,将报告 ae-internal-missing-underscore。
用法示例
/**
* This is some example documentation.
* @internal
*/
export function _doSomething(): void {}