Partager via


VCCLCompilerTool.KeepComments Property

Gets or sets a value indicating whether to suppress a comment strip from source code. KeepComments exposes the functionality of the compiler's /C (Preserve Comments During Preprocessing) option.

Namespace:  Microsoft.VisualStudio.VCProjectEngine
Assembly:  Microsoft.VisualStudio.VCProjectEngine (in Microsoft.VisualStudio.VCProjectEngine.dll)

Syntax

Property KeepComments As Boolean

Dim instance As VCCLCompilerTool
Dim value As Boolean

value = instance.KeepComments

instance.KeepComments = value
bool KeepComments { get; set; }
property bool KeepComments {
    bool get ();
    void set (bool value);
}
function get KeepComments () : boolean
function set KeepComments (value : boolean)

Property Value

Type: System.Boolean

true if a comment strip from source code is suppressed; otherwise, false.

Examples

See How to: Compile Example Code for Project Model Extensibility for information about how to compile and run this example.

The following example modifies the KeepComments property in the integrated development environment (IDE):

' add reference to Microsoft.VisualStudio.VCProjectEngine.
Imports EnvDTE
Imports Microsoft.VisualStudio.VCProjectEngine

Public Module Module1
    Sub Test()
        Dim prj As VCProject
        Dim cfgs, tools As IVCCollection
        Dim cfg As VCConfiguration
        Dim tool As VCCLCompilerTool
        prj = DTE.Solution.Projects.Item(1).Object
        cfgs = prj.Configurations
        cfg = cfgs.Item(1)
        tool = cfg.Tools("VCCLCompilerTool")
        tool.GeneratePreprocessedFile = preprocessOption.preprocessYes
        tool.KeepComments = True
    End Sub
End Module

Permissions

See Also

Reference

VCCLCompilerTool Interface

VCCLCompilerTool Members

Microsoft.VisualStudio.VCProjectEngine Namespace