<!doctype html>
< html class = "default no-js" lang = "zh-CN" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< title > Diagnostic | VS Code API 中文文档< / title >
< meta name = "description" content = "VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaScript API, 这个站点列出了扩展开发者可以使用的所有 vscode api 中文文档,是 vscode 插件开发必备。" >
< meta name = "author" content = "洛竹" >
< meta name = "copyright" content = "洛竹" >
< meta property = "og:title" content = "Vscode Api 中文文档" / >
< meta property = "og:type" content = "docs" >
< meta property = "og:image" content = "https://code.visualstudio.com/favicon.ico" / >
< meta property = "og:url" content = "https://vscode-api-cn.js.org/index.html" >
< meta property = "og:site_name" content = "Vscode Api 中文文档" >
< meta property = "og:description" content = "VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaScript API, 这个站点列出了扩展开发者可以使用的所有 vscode api 中文文档,是 vscode 插件开发必备。" >
< meta property = "article:tag" content = "vscode api" >
< meta property = "article:tag" content = "vscode api 中文文档" >
< meta property = "article:tag" content = "vscode 插件" >
< meta property = "article:tag" content = "vscode 插件开发" >
< meta property = "article:tag" content = "vscode VS Code API 中文文档" >
< meta property = "article:tag" content = "vscode Diagnostic" >
< meta name = "viewport" content = "width=device-width, initial-scale=1, viewport-fit=cover" >
< link rel = "shortcut icon" href = "https://code.visualstudio.com/favicon.ico" sizes = "128x128" >
< link rel = 'canonical' href = 'https://vscode-api-cn.js.org/classes/vscode.Diagnostic.html' / >
< link rel = "stylesheet" href = "../assets/css/main.css" >
< script async src = "../assets/js/search.js" id = "search-script" > < / script >
< script async src = "https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-7962287588031867" crossorigin = "anonymous" > < / script >
<!-- Google tag (gtag.js) -->
< script async src = "https://www.googletagmanager.com/gtag/js?id=G-T4TRRS1LB1" > < / script >
< script >
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-T4TRRS1LB1');
< / script >
< style >
.container-main {
padding-bottom: 50px;
}
< / style >
< / head >
< body >
< header >
< div class = "tsd-page-toolbar" >
< div class = "container" >
< div class = "table-wrap" >
< div class = "table-cell" id = "tsd-search" data-index = "../assets/js/search.json" data-base = ".." >
< div class = "field" >
< label for = "tsd-search-field" class = "tsd-widget search no-caption" > Search< / label >
< input id = "tsd-search-field" type = "text" / >
< / div >
< ul class = "results" >
< li class = "state loading" > Preparing search index...< / li >
< li class = "state failure" > The search index is not available< / li >
< / ul >
< a href = "../index.html" class = "title" > VS Code API 中文文档< / a >
< / div >
< div class = "table-cell" id = "tsd-widgets" >
< div id = "tsd-filter" >
< a href = "#" class = "tsd-widget options no-caption" data-toggle = "options" > Options< / a >
< div class = "tsd-filter-group" >
< div class = "tsd-select" id = "tsd-filter-visibility" >
< span class = "tsd-select-label" > All< / span >
< ul class = "tsd-select-list" >
< li data-value = "public" > Public< / li >
< li data-value = "protected" > Public/Protected< / li >
< li data-value = "private" class = "selected" > All< / li >
< / ul >
< / div >
< input type = "checkbox" id = "tsd-filter-inherited" checked / >
< label class = "tsd-widget" for = "tsd-filter-inherited" > Inherited< / label >
< input type = "checkbox" id = "tsd-filter-externals" checked / >
< label class = "tsd-widget" for = "tsd-filter-externals" > Externals< / label >
< / div >
< / div >
< a href = "#" class = "tsd-widget menu no-caption" data-toggle = "menu" > Menu< / a >
< / div >
< / div >
< / div >
< / div >
< div class = "tsd-page-title" >
< div class = "container" >
< ul class = "tsd-breadcrumb" >
< li >
< a href = "../modules.html" > VS Code API 中文文档< / a >
< / li >
< li >
< a href = "../modules/vscode.html" > vscode< / a >
< / li >
< li >
< a href = "vscode.Diagnostic.html" > Diagnostic< / a >
< / li >
< / ul >
< h1 > Class Diagnostic< / h1 >
< / div >
< / div >
< / header >
< div class = "container container-main" >
< div class = "row" >
< div class = "col-8 col-content" >
< section class = "tsd-panel tsd-comment" >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Represents a diagnostic, such as a compiler error or warning. Diagnostic objects
are only valid in the scope of a file.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-hierarchy" >
< h3 > 层级< / h3 >
< ul class = "tsd-hierarchy" >
< li >
< span class = "target" > Diagnostic< / span >
< / li >
< / ul >
< / section >
< section class = "tsd-panel-group tsd-index-group" >
< h2 > 索引< / h2 >
< section class = "tsd-panel tsd-index-panel" >
< div class = "tsd-index-content" >
< section class = "tsd-index-section " >
< h3 > Constructors( 1) < / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-constructor tsd-parent-kind-class" > < a href = "vscode.Diagnostic.html#constructor" class = "tsd-kind-icon" > constructor< / a > < / li >
< / ul >
< / section >
< section class = "tsd-index-section " >
< h3 > Properties( 7) < / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "vscode.Diagnostic.html#range" class = "tsd-kind-icon" > range< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "vscode.Diagnostic.html#message" class = "tsd-kind-icon" > message< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "vscode.Diagnostic.html#severity" class = "tsd-kind-icon" > severity< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "vscode.Diagnostic.html#source" class = "tsd-kind-icon" > source< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "vscode.Diagnostic.html#code" class = "tsd-kind-icon" > code< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "vscode.Diagnostic.html#relatedInformation" class = "tsd-kind-icon" > related< wbr > Information< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "vscode.Diagnostic.html#tags" class = "tsd-kind-icon" > tags< / a > < / li >
< / ul >
< / section >
< / div >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Constructors( 1) < / h2 >
< section class = "tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class" >
< a name = "constructor" class = "tsd-anchor" > < / a >
< h3 > constructor< / h3 >
< ul class = "tsd-signatures tsd-kind-constructor tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > new < wbr > Diagnostic< span class = "tsd-signature-symbol" > (< / span > range< span class = "tsd-signature-symbol" > : < / span > < a href = "vscode.Range.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Range< / a > , message< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > , severity< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../enums/vscode.DiagnosticSeverity.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > DiagnosticSeverity< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "vscode.Diagnostic.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Diagnostic< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn.js.org/blob/424ab42/vscode.d.ts#L5345" > vscode.d.ts:5345< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Creates a new diagnostic object.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > range: < a href = "vscode.Range.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Range< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The range to which this diagnostic applies.< / p >
< / div >
< / div >
< / li >
< li >
< h5 > message: < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The human-readable message.< / p >
< / div >
< / div >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > severity: < a href = "../enums/vscode.DiagnosticSeverity.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > DiagnosticSeverity< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The severity, default is < a href = "../enums/vscode.DiagnosticSeverity.html#Error" > error< / a > .< / p >
< / div >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "vscode.Diagnostic.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Diagnostic< / a > < / h4 >
< / li >
< / ul >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Properties( 7) < / h2 >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "range" class = "tsd-anchor" > < / a >
< h3 > range< / h3 >
< div class = "tsd-signature tsd-kind-icon" > range< span class = "tsd-signature-symbol" > :< / span > < a href = "vscode.Range.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Range< / a > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn.js.org/blob/424ab42/vscode.d.ts#L5292" > vscode.d.ts:5292< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The range to which this diagnostic applies.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "message" class = "tsd-anchor" > < / a >
< h3 > message< / h3 >
< div class = "tsd-signature tsd-kind-icon" > message< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn.js.org/blob/424ab42/vscode.d.ts#L5297" > vscode.d.ts:5297< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The human-readable message.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "severity" class = "tsd-anchor" > < / a >
< h3 > severity< / h3 >
< div class = "tsd-signature tsd-kind-icon" > severity< span class = "tsd-signature-symbol" > :< / span > < a href = "../enums/vscode.DiagnosticSeverity.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > DiagnosticSeverity< / a > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn.js.org/blob/424ab42/vscode.d.ts#L5302" > vscode.d.ts:5302< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The severity, default is < a href = "../enums/vscode.DiagnosticSeverity.html#Error" > error< / a > .< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "source" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > source< / h3 >
< div class = "tsd-signature tsd-kind-icon" > source< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn.js.org/blob/424ab42/vscode.d.ts#L5308" > vscode.d.ts:5308< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > A human-readable string describing the source of this
diagnostic, e.g. ' typescript' or ' super lint' .< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "code" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > code< / h3 >
< div class = "tsd-signature tsd-kind-icon" > code< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-symbol" > { < / span > value< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > target< span class = "tsd-signature-symbol" > : < / span > < a href = "vscode.Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > < span class = "tsd-signature-symbol" > }< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn.js.org/blob/424ab42/vscode.d.ts#L5314" > vscode.d.ts:5314< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > A code or identifier for this diagnostic.
Should be used for later processing, e.g. when providing < a href = "../interfaces/vscode.CodeActionContext.html" > code actions< / a > .< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "relatedInformation" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > related< wbr > Information< / h3 >
< div class = "tsd-signature tsd-kind-icon" > related< wbr > Information< span class = "tsd-signature-symbol" > :< / span > < a href = "vscode.DiagnosticRelatedInformation.html" class = "tsd-signature-type" data-tsd-kind = "Class" > DiagnosticRelatedInformation< / a > < span class = "tsd-signature-symbol" > []< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn.js.org/blob/424ab42/vscode.d.ts#L5331" > vscode.d.ts:5331< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > An array of related diagnostic information, e.g. when symbol-names within
a scope collide all definitions can be marked via this property.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "tags" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > tags< / h3 >
< div class = "tsd-signature tsd-kind-icon" > tags< span class = "tsd-signature-symbol" > :< / span > < a href = "../enums/vscode.DiagnosticTag.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > DiagnosticTag< / a > < span class = "tsd-signature-symbol" > []< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn.js.org/blob/424ab42/vscode.d.ts#L5336" > vscode.d.ts:5336< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Additional metadata about the diagnostic.< / p >
< / div >
< / div >
< / section >
< / section >
< div class = "tsd-panel tsd-typography" >
< ins class = "adsbygoogle" style = "display:block" data-ad-format = "autorelaxed" data-ad-client = "ca-pub-7962287588031867"
data-ad-slot="3578139931">< / ins >
< script > ( adsbygoogle = window . adsbygoogle || [ ] ) . push ( { } ) ; < / script >
< / div >
< / div >
< div class = "col-4 col-menu menu-sticky-wrap menu-highlight" >
< nav class = "tsd-navigation primary" >
< ul >
< li class = " " >
< a href = "../modules.html" > Exports< / a >
< / li >
< li class = "current tsd-kind-namespace" >
< a href = "../modules/vscode.html" > vscode< / a >
< ul >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.authentication.html" > authentication< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.commands.html" > commands< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.comments.html" > comments< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.debug.html" > debug< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.env.html" > env< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.extensions.html" > extensions< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.languages.html" > languages< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.notebooks.html" > notebooks< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.scm.html" > scm< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.tasks.html" > tasks< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.tests.html" > tests< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.window.html" > window< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.workspace.html" > workspace< / a >
< / li >
< / ul >
< / li >
< / ul >
< / nav >
< nav class = "tsd-navigation secondary menu-sticky" >
< div style = "width: 200px" >
< script async = "async" type = "text/javascript" id = "clstr_globe" src = "//clustrmaps.com/globe.js?d=cMnk-gSDNcAzNMMm67U8rWRaHnjUc0Xb0giSGndepK4" > < / script >
< / div >
< ul class = "before-current" >
< / ul >
< ul class = "current" >
< li class = "current tsd-kind-class tsd-parent-kind-namespace" >
< a href = "vscode.Diagnostic.html" class = "tsd-kind-icon" > Diagnostic< / a >
< ul >
< li class = " tsd-kind-constructor tsd-parent-kind-class" >
< a href = "vscode.Diagnostic.html#constructor" class = "tsd-kind-icon" > constructor< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "vscode.Diagnostic.html#range" class = "tsd-kind-icon" > range< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "vscode.Diagnostic.html#message" class = "tsd-kind-icon" > message< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "vscode.Diagnostic.html#severity" class = "tsd-kind-icon" > severity< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "vscode.Diagnostic.html#source" class = "tsd-kind-icon" > source< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "vscode.Diagnostic.html#code" class = "tsd-kind-icon" > code< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "vscode.Diagnostic.html#relatedInformation" class = "tsd-kind-icon" > related< wbr > Information< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "vscode.Diagnostic.html#tags" class = "tsd-kind-icon" > tags< / a >
< / li >
< / ul >
< / li >
< / ul >
< ul class = "after-current" >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< footer class = "with-border-bottom" >
< div class = "container" >
< h2 > 图例< / h2 >
< div class = "tsd-legend-group" >
< ul class = "tsd-legend" >
< li class = "tsd-kind-constructor tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Constructor< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< / ul >
< / div >
< / div >
< / footer >
< div class = "container tsd-generator" >
< p > 友链:< a href = "https://jeasonstudio.gitbooks.io/vscode-cn-doc/content/" target = "_blank" > VS Code 中文文档< / a > | < a href = "https://code.visualstudio.com/docs" target = "_blank" > VS Code 官网文档< / a > | < a href = "https://marketplace.visualstudio.com/" target = "_blank" > VS Code 扩展市场< / a > < / p >
< p > Generated by < a href = "https://typedoc.org/" target = "_blank" > TypeDoc< / a > . Maintained by < a href = "https://youngjuning.js.org" target = "_blank" > 洛竹< / a > < / p >
< / div >
< div class = "overlay" > < / div >
< script src = "../assets/js/main.js" > < / script >
< / body >
< / html >