Provides an abstract base class for performing auto-complete of .NET language documentation comments when appropriate.
- Inheritance:
- object object
- Implements:
-
IDocumentation
Comment Auto Completer
Constructors
DocumentationCommentAutoCompleterBase()
Initializes an instance of the class.
Properties
IsEndTagCompletionEnabled
Gets or sets whether documentation comment end tag completion is enabled.
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.
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.
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.
Parameter | Type | Description |
---|---|---|
view | IEditor |
The IEditor |
targetSnapshotOffset | Text |
A Text |
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.
Parameter | Type | Description |
---|---|---|
parseData | IDot |
The IDot |
snapshotOffset | Text |
The Text |
Returns
- Text
Snapshot :Offset The translated offset.