ProvideLanguageServiceAttribute.EnableCommenting Property

Definition

Namespace:

Microsoft.VisualStudio.Shell

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Package:

Microsoft.VisualStudio.Shell.15.0 v17.11.40262

Determines whether the language service can comment and uncomment source code using a single command.

public:
 property bool EnableCommenting { bool get(); void set(bool value); };

public:
 property bool EnableCommenting { bool get(); void set(bool value); };

public bool EnableCommenting { get; set; }

member this.EnableCommenting : bool with get, set

Public Property EnableCommenting As Boolean

Property Value

Boolean

Returns true if commenting is supported; otherwise, returns false.

Examples

[ProvideLanguageService(typeof(MyLanguageService),           // Required  
                        MyConstants.languageName,            // Required  
                        MyConstants.languageNameResourceID,  // Required  
    // Optional language service properties  
    EnableCommenting = true,  // Commenting/uncommenting is supported  
                       )]  

Remarks

Visual Studio supplies an advanced editing option that can comment out an entire section of source code with a single command (Edit -> Advanced -> Comment Selection menu command). There is also a command to uncomment a section of code. If this feature is supported by the language service, then the EnableCommenting property should be set to true.

This property is specific to the managed package framework (MPF).

The default is true when the corresponding registry entry is accessed through the LanguagePreferences class.

The registry entry looks like this:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VisualStudio\[X.Y]\Languages\Language Services\  
  [Language Name]\  
    EnableCommenting = reg_dword: 0x00000001