<!doctype html>
< html class = "default no-js" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< title > Comment | VS Code API 中文文档< / title >
< meta name = "description" content = "Documentation for VS Code API 中文文档" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< link rel = "stylesheet" href = "../assets/css/main.css" >
< script async src = "../assets/js/search.js" id = "search-script" > < / script >
< / 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 = "../index.html" > VS Code API 中文文档< / a >
< / li >
< li >
< a href = "Comment.html" > Comment< / a >
< / li >
< / ul >
< h1 > Interface Comment< / 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 > A comment is displayed within the editor or the Comments Panel, depending on how it is provided.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-hierarchy" >
< h3 > Hierarchy< / h3 >
< ul class = "tsd-hierarchy" >
< li >
< span class = "target" > Comment< / span >
< / li >
< / ul >
< / section >
< section class = "tsd-panel-group tsd-index-group" >
< h2 > Index< / h2 >
< section class = "tsd-panel tsd-index-panel" >
< div class = "tsd-index-content" >
< section class = "tsd-index-section " >
< h3 > Properties< / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "Comment.html#body" class = "tsd-kind-icon" > body< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "Comment.html#mode" class = "tsd-kind-icon" > mode< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "Comment.html#author" class = "tsd-kind-icon" > author< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "Comment.html#contextValue" class = "tsd-kind-icon" > context< wbr > Value< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "Comment.html#reactions" class = "tsd-kind-icon" > reactions< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "Comment.html#label" class = "tsd-kind-icon" > label< / a > < / li >
< / ul >
< / section >
< / div >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Properties< / h2 >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "body" class = "tsd-anchor" > < / a >
< h3 > body< / h3 >
< div class = "tsd-signature tsd-kind-icon" > body< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../classes/MarkdownString.html" class = "tsd-signature-type" data-tsd-kind = "Class" > MarkdownString< / a > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/bc2a9f9/vscode.d.ts#L13455" > vscode.d.ts:13455< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The human-readable comment body< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "mode" class = "tsd-anchor" > < / a >
< h3 > mode< / h3 >
< div class = "tsd-signature tsd-kind-icon" > mode< span class = "tsd-signature-symbol" > :< / span > < a href = "../enums/CommentMode.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > CommentMode< / a > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/bc2a9f9/vscode.d.ts#L13460" > vscode.d.ts:13460< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > < a href = "../enums/CommentMode.html" > Comment mode< / a > of the comment< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "author" class = "tsd-anchor" > < / a >
< h3 > author< / h3 >
< div class = "tsd-signature tsd-kind-icon" > author< span class = "tsd-signature-symbol" > :< / span > < a href = "CommentAuthorInformation.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > CommentAuthorInformation< / a > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/bc2a9f9/vscode.d.ts#L13465" > vscode.d.ts:13465< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The < a href = "CommentAuthorInformation.html" > author information< / a > of the comment< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "contextValue" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > context< wbr > Value< / h3 >
< div class = "tsd-signature tsd-kind-icon" > context< wbr > Value< 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/blob/bc2a9f9/vscode.d.ts#L13485" > vscode.d.ts:13485< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Context value of the comment. This can be used to contribute comment specific actions.
For example, a comment is given a context value as < code > editable< / code > . When contributing actions to < code > comments/comment/title< / code >
using < code > menus< / code > extension point, you can specify context value for key < code > comment< / code > in < code > when< / code > expression like < code > comment == editable< / code > .< / p >
< pre > < code class = "language-json" > < span style = "color: #000000" > < / span > < span style = "color: #A31515" > " contributes" < / span > < span style = "color: #000000" > : {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #0451A5" > " menus" < / span > < span style = "color: #000000" > : {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #0451A5" > " comments/comment/title" < / span > < span style = "color: #000000" > : [< / span >
< span style = "color: #000000" > {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #0451A5" > " command" < / span > < span style = "color: #000000" > : < / span > < span style = "color: #A31515" > " extension.deleteComment" < / span > < span style = "color: #000000" > ,< / span >
< span style = "color: #000000" > < / span > < span style = "color: #0451A5" > " when" < / span > < span style = "color: #000000" > : < / span > < span style = "color: #A31515" > " comment == editable" < / span >
< span style = "color: #000000" > }< / span >
< span style = "color: #000000" > ]< / span >
< span style = "color: #000000" > }< / span >
< span style = "color: #000000" > }< / span >
< / code > < / pre >
< p > This will show action < code > extension.deleteComment< / code > only for comments with < code > contextValue< / code > is < code > editable< / code > .< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "reactions" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > reactions< / h3 >
< div class = "tsd-signature tsd-kind-icon" > reactions< span class = "tsd-signature-symbol" > :< / span > < a href = "CommentReaction.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > CommentReaction< / a > < span class = "tsd-signature-symbol" > []< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/bc2a9f9/vscode.d.ts#L13490" > vscode.d.ts:13490< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Optional reactions of the < a href = "../enums/FoldingRangeKind.html#Comment" > Comment< / a > < / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "label" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > label< / h3 >
< div class = "tsd-signature tsd-kind-icon" > label< 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/blob/bc2a9f9/vscode.d.ts#L13496" > vscode.d.ts:13496< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Optional label describing the < a href = "../enums/FoldingRangeKind.html#Comment" > Comment< / a >
Label will be rendered next to authorName if exists.< / p >
< / div >
< / div >
< / section >
< / section >
< / div >
< div class = "col-4 col-menu menu-sticky-wrap menu-highlight" >
< nav class = "tsd-navigation primary" >
< ul >
< li class = " " >
< a href = "../index.html" > Exports< / a >
< / li >
< / ul >
< / nav >
< nav class = "tsd-navigation secondary menu-sticky" >
< ul class = "before-current" >
< / ul >
< ul class = "current" >
< li class = "current tsd-kind-interface" >
< a href = "Comment.html" class = "tsd-kind-icon" > Comment< / a >
< ul >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "Comment.html#body" class = "tsd-kind-icon" > body< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "Comment.html#mode" class = "tsd-kind-icon" > mode< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "Comment.html#author" class = "tsd-kind-icon" > author< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "Comment.html#contextValue" class = "tsd-kind-icon" > context< wbr > Value< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "Comment.html#reactions" class = "tsd-kind-icon" > reactions< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "Comment.html#label" class = "tsd-kind-icon" > label< / a >
< / li >
< / ul >
< / li >
< / ul >
< ul class = "after-current" >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< footer class = "with-border-bottom" >
< div class = "container" >
< h2 > Legend< / 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 >
< li class = "tsd-kind-method tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited method< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-static" > < span class = "tsd-kind-icon" > Static property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-static" > < span class = "tsd-kind-icon" > Static method< / span > < / li >
< / ul >
< / div >
< / div >
< / footer >
< div class = "container tsd-generator" >
< p > Generated using < a href = "https://typedoc.org/" target = "_blank" > TypeDoc< / a > < / p >
< / div >
< div class = "overlay" > < / div >
< script src = "../assets/js/main.js" > < / script >
< / body >
< / html >
