DocumentationCommentAutoCompleterBase Class
Provides an abstract base class for performing auto-complete of .NET language documentation comments when appropriate.
public abstract class DocumentationCommentAutoCompleterBase : IDocumentationCommentAutoCompleter
- Inheritance:
- object object
- Implements:
- IDocumentationCommentAutoCompleter
Constructors
DocumentationCommentAutoCompleterBase()
Initializes an instance of the class.
protected DocumentationCommentAutoCompleterBase()
Properties
IsEndTagCompletionEnabled
Gets or sets whether documentation comment end tag completion is enabled.
public bool IsEndTagCompletionEnabled { get; set; }
Property Value
- bool:
true
if documentation comment end tag completion is enabled; otherwise,false
.
IsNewLineGenerationEnabled
Gets or sets whether documentation comment delimiter auto-generation is enabled when pressing Enter
while in a documentation comment.
public bool IsNewLineGenerationEnabled { get; set; }
Property Value
- bool:
true
if documentation comment delimiter auto-generation is enabled when pressingEnter
while in a documentation comment; otherwise,false
.
IsStubGenerationEnabled
Gets or sets whether stub documentation comment auto-generation is enabled when starting to type new documentation comments.
public bool IsStubGenerationEnabled { get; set; }
Property Value
- bool:
true
if stub documentation comment auto-generation is enabled when starting to type new documentation comments; otherwise,false
.
Methods
InsertStubDocumentationComment(IEditorView, TextSnapshotOffset, string)
Attempts to insert a stub documentation comment at the caret's location.
protected virtual void InsertStubDocumentationComment(IEditorView view, TextSnapshotOffset targetSnapshotOffset, string delimiter)
Parameter | Type | Description |
---|---|---|
view | IEditorView | The IEditorView to examine. |
targetSnapshotOffset | TextSnapshotOffset | A TextSnapshotOffset indicating the offset at which the target type/member is located. |
delimiter | string | The documentation comment delimiter. |
TranslateToParseDataSnapshot(IDotNetParseData, TextSnapshotOffset)
Translates the specified snapshot offset to the parse data's Snapshot, if possible, prior to containing AST node lookup.
protected virtual TextSnapshotOffset TranslateToParseDataSnapshot(IDotNetParseData parseData, TextSnapshotOffset snapshotOffset)
Parameter | Type | Description |
---|---|---|
parseData | IDotNetParseData | The IDotNetParseData to examine. |
snapshotOffset | TextSnapshotOffset | The TextSnapshotOffset to translate. |
Returns
- TextSnapshotOffset:
The translated offset.