Share via

VCCLCompilerTool.KeepComments Property

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.VCProjectEngine
Assembly:
Microsoft.VisualStudio.VCProjectEngine.dll
Package:
Microsoft.VisualStudio.VCProjectEngine v17.11.40252

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.

public:
 property bool KeepComments { bool get(); void set(bool value); };
public:
 property bool KeepComments { bool get(); void set(bool value); };
[System.Runtime.InteropServices.DispId(63)]
public bool KeepComments { [System.Runtime.InteropServices.DispId(63)] get; [System.Runtime.InteropServices.DispId(63)] set; }
[<System.Runtime.InteropServices.DispId(63)>]
[<get: System.Runtime.InteropServices.DispId(63)>]
[<set: System.Runtime.InteropServices.DispId(63)>]
member this.KeepComments : bool with get, set
Public Property KeepComments As Boolean

Property Value

Boolean

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

Attributes
DispIdAttribute

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

Applies to