KeepComments Property
Collapse the table of content
Expand the table of content
Important This document may not represent best practices for current development, links to downloads and other resources may no longer be valid. Current recommended version can be found here. ArchiveDisclaimer

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 option.

Namespace: Microsoft.VisualStudio.VCProjectEngine
Assembly: Microsoft.VisualStudio.VCProjectEngine (in microsoft.visualstudio.vcprojectengine.dll)

Property KeepComments As Boolean
Dim instance As VCCLCompilerTool
Dim value As Boolean

value = instance.KeepComments

instance.KeepComments = value
/** @property */
boolean get_KeepComments ()

/** @property */
void set_KeepComments (/** @attribute InAttribute() */ boolean bkeepComments)

function get KeepComments () : boolean

function set KeepComments (bkeepComments : boolean)

Property Value

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

See Examples 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
© 2016 Microsoft