Class: OperationIdTagParser

Defined in: src/parsers/OperationIdTagParser.ts:14

操作ID解析器，处理 @operationId 标签

Extends

• TagParser

Constructors

Constructor

new OperationIdTagParser(context: ParseContext): OperationIdTagParser

Defined in: src/parsers/TagParser.ts:39

创建标签解析器实例。

Parameters

context

ParseContext

解析上下文。

Returns

OperationIdTagParser

Inherited from

TagParser.constructor

Properties

context

context: ParseContext

Defined in: src/parsers/TagParser.ts:39

解析上下文。

Inherited from

TagParser.context

---

tags

tags: string[]

Defined in: src/parsers/OperationIdTagParser.ts:15

解析器支持的 JSDoc 标签名称列表

Overrides

TagParser.tags

Methods

extractTagContentLines()

protected extractTagContentLines(tag: JSDocTag): string[]

Defined in: src/parsers/TagParser.ts:69

获取标签的完整多行内容。

Parameters

tag

JSDocTag

JSDoc 标签对象。

Returns

string[]

标签的所有行文本内容，保留缩进格式，去掉星号和星号前空格，去掉尾部连续的空行。

Inherited from

TagParser.extractTagContentLines

---

getTags()

getTags(): (JSDocTagName | string & object)[]

Defined in: src/parsers/TagParser.ts:45

获取解析器支持的标签名称。

Returns

(JSDocTagName | string & object)[]

解析器支持的标签名称数组。

Inherited from

TagParser.getTags

---

parse()

parse(tag: JSDocTag): Promise<OperationData>

Defined in: src/parsers/OperationIdTagParser.ts:22

解析 JSDoc 标签。

Parameters

tag

JSDocTag

JSDoc 标签对象。

Returns

Promise<OperationData>

解析结果。

Overrides

TagParser.parse

---

parseTagParamsWithYaml()

protected parseTagParamsWithYaml(tag: JSDocTag): Promise<ParsedTagParams>

Defined in: src/parsers/TagParser.ts:94

解析标签 inline 和 YAML 参数。

Parameters

tag

JSDocTag

JSDoc 标签对象。

Returns

Promise<ParsedTagParams>

返回一个对象，包含：

• inline: inline 参数数组（通常为标签行的参数部分）
• yaml: YAML 参数对象（如果存在 YAML 参数并解析成功，否则为 undefined）
• rawText: 标签的原始注释文本内容

Inherited from

TagParser.parseTagParamsWithYaml

---

transformParams()

protected transformParams(params: ParsedTagParams): object

Defined in: src/parsers/OperationIdTagParser.ts:34

转换参数的钩子方法，子类可以重写此方法来完全控制参数转换。

Parameters

params

ParsedTagParams

参数对象。

Returns

object

转换后的参数对象。

operationId

operationId: string

Overrides

TagParser.transformParams