@@ -56,7 +56,10 @@ commands二级模块对象,用于处理和`命令`相关的逻辑。`命令`
5656| command | String | 要执行的` 命令 ` id |
5757
5858#### 返回值
59- 无
59+ | 返回类型 | 描述 |
60+ | -- | -- |
61+ | Promise | Promise对象|
62+
6063
6164#### 示例
6265``` javascript
@@ -115,12 +118,12 @@ hx.commands.executeCommand('workbench.action.closeAllEditors')
115118languages二级模块对象,用于处理和编程语言相关的逻辑,目前仅支持校验文档时创建问题列表。
116119
117120### createDiagnosticCollection
118- 创建一个问题列表
121+ 创建一个问题列表,可用于文档校验时在文档出错区域显示波浪线标识问题。
119122#### 参数说明
120123
121124| 参数名称 | 参数类型 | 描述 |
122125| -- | -- | -- |
123- | name | String | 问题列表名称 |
126+ | name | String | 问题列表名称,当鼠标移至波浪线上时会显示在tooltips中 |
124127
125128#### 返回值
126129| 返回类型 | 描述 |
@@ -292,7 +295,7 @@ window二级模块对象,用于处理主窗口相关的逻辑。
292295` ` `
293296
294297### getActiveTextEditor
295- 获取当前激活的编辑器
298+ 获取当前激活的编辑器,如果没有打开的编辑器返回undefined
296299#### 参数说明
297300无
298301
@@ -301,6 +304,7 @@ window二级模块对象,用于处理主窗口相关的逻辑。
301304|返回类型 |描述 |
302305|-- |-- |
303306|Promise<[TextEditor](#TextEditor)> |返回当前激活的编辑器|
307+
304308#### 示例
305309` ` ` javascript
306310 let activeEditor = hx .window .getActiveTextEditor ();
@@ -334,12 +338,12 @@ window二级模块对象,用于处理主窗口相关的逻辑。
334338` ` `
335339
336340### createOutputChannel
337- 创建一个输出控制台,可用于在控制台打印日志信息 。
341+ 创建一个输出控制台通道,可用于在控制台输出文本内容 。
338342#### 参数说明
339343
340- |参数名称 |参数类型 |描述 |
341- |-- |-- |-- |
342- |channel |String |控制台通道名称 |
344+ |参数名称 |参数类型 |描述 |
345+ |-- |-- |-- |
346+ |channel |String |控制台通道名称,在添加内容到控制台时,会将该名称作为前缀输出,eg:[ ${ channel } ] 这是要输出的内容。 |
343347
344348#### 返回值
345349|返回类型 |描述 |
@@ -440,7 +444,7 @@ workspace二级模块对象,用于处理和工作空间以及文档事件有
440444` ` `
441445
442446### applyEdit
443- 执行指定的文档uri编辑工作空间内已打开的文档 。
447+ 根据指定的WorkspaceEdit对象编辑文档。WorkspaceEdit对象内要设定被修改文档的uri和要执行修改的TextEdit操作对象 。
444448#### 参数说明
445449
446450|参数名称 |参数类型 |描述 |
@@ -567,7 +571,7 @@ workspace二级模块对象,用于处理和工作空间以及文档事件有
567571
568572
569573### lineAt
570- 获取指定的行信息
574+ 获取指定行号的行信息
571575
572576|参数名称 |参数类型 |描述 |
573577|-- |-- |-- |
@@ -684,7 +688,7 @@ workspace二级模块对象,用于处理和工作空间以及文档事件有
684688|end |Number |结束位置 |
685689
686690## OutputChannel
687- 输出通道
691+ 输出通道,在添加内容到控制台时,会将通道名称作为前缀输出,eg:[ ${ channel } ] 这是要输出的内容。
688692### 属性列表
689693|属性名 |属性类型 |描述 |
690694|-- |-- |-- |
@@ -820,9 +824,9 @@ workspace二级模块对象,用于处理和工作空间以及文档事件有
820824
821825#### 示例
822826` ` ` javascript
823- let workspaceEdit = new WorkspaceEdit ();
827+ let workspaceEdit = new hx. WorkspaceEdit ();
824828 let edits = [];
825- edits .push (new TextEdit ({
829+ edits .push (new hx. TextEdit ({
826830 start: 0 ,
827831 end: 0
828832 }, " foo" ));
0 commit comments