ProvideLanguageServiceAttribute.EnableCommenting Property


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

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

public bool EnableCommenting { get; set; }

Property Value

Type: System.Boolean

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

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

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