View source

typedef Comment

package vscode

A comment is displayed within the editor or the Comments Panel, depending on how it is provided.

Fields

@:optionaloptionalreactions:Null<Array<CommentReaction>>

Optional reactions of the {@link Comment}

mode:CommentMode

{@link CommentMode Comment mode} of the comment

@:optionaloptionallabel:Null<String>

Optional label describing the {@link Comment} Label will be rendered next to authorName if exists.

@:optionaloptionalcontextValue:Null<String>

Context value of the comment. This can be used to contribute comment specific actions. For example, a comment is given a context value as editable. When contributing actions to comments/comment/title using menus extension point, you can specify context value for key comment in when expression like comment == editable.

	"contributes": {
"menus": {
	"comments/comment/title": [
		{
			"command": "extension.deleteComment",
			"when": "comment == editable"
		}
	]
}
	}

This will show action extension.deleteComment only for comments with contextValue is editable.

body:EitherType<String, MarkdownString>

The human-readable comment body

author:CommentAuthorInformation

The {@link CommentAuthorInformation author information} of the comment