Export (0) Print
Expand All

IVsCommentTaskToken Interface

Represents one comment task token.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in microsoft.visualstudio.shell.interop.dll)

[GuidAttribute("327C43D7-CCB1-41D7-9A7B-CE87751201F7")] 
[InterfaceTypeAttribute(1)] 
public interface IVsCommentTaskToken
/** @attribute GuidAttribute("327C43D7-CCB1-41D7-9A7B-CE87751201F7") */ 
/** @attribute InterfaceTypeAttribute(1) */ 
public interface IVsCommentTaskToken
GuidAttribute("327C43D7-CCB1-41D7-9A7B-CE87751201F7") 
InterfaceTypeAttribute(1) 
public interface IVsCommentTaskToken

This interface encapsulates the information about a particular comment task token that a user enters via the Task List node of the Environment tree from the Options menu item of the Tools menu. Packages can use this information to find a particular comment task token in order to create its respective task in the task list.

When a document is opened it is parsed for comment identifiers (such as /* in C), and the first non-white space text following any comment identifier is parsed to see if it matches the text of any comment task tokens. If there is a match, a comment task token has been identified. Note that the text that identifies the comment task token is case sensitive.

See illustrations of the calling of this interface in the sample Figures Language Service Sample.

Notes to Callers Task providers would call this interface to get information about a particular comment task token.

Community Additions

ADD
Show:
© 2015 Microsoft