IDocumentationCommentAutoCompleter Interface

Provides the base requirements for a class that can auto-complete .NET language documentation comments when appropriate.

public interface IDocumentationCommentAutoCompleter

Remarks

Instances of this object can be registered with an ISyntaxLanguage using the RegisterService(object, object) method. Once an instance is registered with the language for the IDocumentationCommentAutoCompleter interface type, its features can be used by the language.

Gets whether documentation comment end tag completion is enabled.

bool IsEndTagCompletionEnabled { get; }

bool:: true if documentation comment end tag completion is enabled; otherwise, false.

Gets whether documentation comment delimiter auto-generation is enabled when pressing Enter while in a documentation comment.

bool IsNewLineGenerationEnabled { get; }

bool:: true if documentation comment delimiter auto-generation is enabled when pressing Enter while in a documentation comment; otherwise, false.

Gets whether stub documentation comment auto-generation is enabled when starting to type new documentation comments.

bool IsStubGenerationEnabled { get; }

bool:: true if stub documentation comment auto-generation is enabled when starting to type new documentation comments; otherwise, false.