IVsCommentTaskToken Interface

Represents one comment task token.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

public interface IVsCommentTaskToken

The IVsCommentTaskToken type exposes the following members.

Public methodPriorityReturns the priority of a comment task token.
Public methodTextReturns the text of a comment task token.

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.

Notes to Callers

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2015 Microsoft