VBCodeProviderWithDocs Class

This is a custom VB.NET code provider that is able to output an individual XML comments file for each unit that is compiled to a folder of your choice.

Definition

Namespace: EWSoftware.CodeDom
Assembly: EWSoftware.CodeDom (in EWSoftware.CodeDom.dll) Version: 2022.3.12.0
public class VBCodeProviderWithDocs : VBCodeProvider
Inheritance
Object    MarshalByRefObject    Component    CodeDomProvider    VBCodeProvider    VBCodeProviderWithDocs

Remarks

This changes the default behavior which overwrites the comments file on each invocation and/or dumps them into the temporary ASP.NET compilation folder.

A /docpath:[path] option should be added to the compilerOptions attribute in the Web.config file to specify the path to which the XML comments files will be written. The filenames will match the assembly names generated by the compiler.

Example

Example Compiler Configuration
<configuration>
    <system.codedom>
      <compilers>
        <!-- For VB.NET -->
        <compiler language="vb;vbs;visualbasic;vbscript" extension=".vb"
          compilerOptions="/docpath:C:\Publish\Doc"
          type="EWSoftware.CodeDom.VBCodeProviderWithDocs,
              EWSoftware.CodeDom, Version=1.0.0.0, Culture=neutral,
              PublicKeyToken=d633d7d5b41cbb65" />
      </compilers>
    </system.codedom>
</configuration>

Constructors

VBCodeProviderWithDocs Default constructor
VBCodeProviderWithDocs(IDictionaryString, String) This constructor is passed a provider options dictionary

Properties

CanRaiseEventsGets a value indicating whether the component can raise an event.
(Inherited from Component)
ContainerGets the IContainer that contains the Component.
(Inherited from Component)
DesignModeGets a value that indicates whether the Component is currently in design mode.
(Inherited from Component)
EventsGets the list of event handlers that are attached to this Component.
(Inherited from Component)
FileExtensionGets the file name extension to use when creating source code files.
(Inherited from VBCodeProvider)
LanguageOptionsGets a language features identifier.
(Inherited from VBCodeProvider)
SiteGets or sets the ISite of the Component.
(Inherited from Component)

Methods

CompileAssemblyFromDomCompiles an assembly based on the System.CodeDom trees contained in the specified array of CodeCompileUnit objects, using the specified compiler settings.
(Overrides CodeDomProviderCompileAssemblyFromDom(CompilerParameters, CodeCompileUnit))
CompileAssemblyFromFileCompiles an assembly from the source code contained in the specified files, using the specified compiler settings.
(Overrides CodeDomProviderCompileAssemblyFromFile(CompilerParameters, String))
CompileAssemblyFromSourceCompiles an assembly from the specified array of strings containing source code, using the specified compiler settings.
(Overrides CodeDomProviderCompileAssemblyFromSource(CompilerParameters, String))
CreateCompilerGets an instance of the Visual Basic code compiler.
(Inherited from VBCodeProvider)
Obsolete.
CreateEscapedIdentifierCreates an escaped identifier for the specified value.
(Inherited from CodeDomProvider)
CreateGeneratorGets an instance of the Visual Basic code generator.
(Inherited from VBCodeProvider)
Obsolete.
CreateGenerator(String)When overridden in a derived class, creates a new code generator using the specified file name for output.
(Inherited from CodeDomProvider)
CreateGenerator(TextWriter)When overridden in a derived class, creates a new code generator using the specified TextWriter for output.
(Inherited from CodeDomProvider)
CreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject)
CreateParserWhen overridden in a derived class, creates a new code parser.
(Inherited from CodeDomProvider)
Obsolete.
CreateValidIdentifierCreates a valid identifier for the specified value.
(Inherited from CodeDomProvider)
DisposeReleases all resources used by the Component.
(Inherited from Component)
Dispose(Boolean)Releases the unmanaged resources used by the Component and optionally releases the managed resources.
(Inherited from Component)
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeReleases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
(Inherited from Component)
GenerateCodeFromCompileUnitGenerates code for the specified Code Document Object Model (CodeDOM) compilation unit and sends it to the specified text writer, using the specified options.
(Inherited from CodeDomProvider)
GenerateCodeFromExpressionGenerates code for the specified Code Document Object Model (CodeDOM) expression and sends it to the specified text writer, using the specified options.
(Inherited from CodeDomProvider)
GenerateCodeFromMemberGenerates code for the specified class member using the specified text writer and code generator options.
(Inherited from VBCodeProvider)
GenerateCodeFromNamespaceGenerates code for the specified Code Document Object Model (CodeDOM) namespace and sends it to the specified text writer, using the specified options.
(Inherited from CodeDomProvider)
GenerateCodeFromStatementGenerates code for the specified Code Document Object Model (CodeDOM) statement and sends it to the specified text writer, using the specified options.
(Inherited from CodeDomProvider)
GenerateCodeFromTypeGenerates code for the specified Code Document Object Model (CodeDOM) type declaration and sends it to the specified text writer, using the specified options.
(Inherited from CodeDomProvider)
GetConverterGets a TypeConverter for the specified type of object.
(Inherited from VBCodeProvider)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
GetServiceReturns an object that represents a service provided by the Component or by its Container.
(Inherited from Component)
GetTypeGets the Type of the current instance.
(Inherited from Object)
GetTypeOutputGets the type indicated by the specified CodeTypeReference.
(Inherited from CodeDomProvider)
InitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
IsValidIdentifierReturns a value that indicates whether the specified value is a valid identifier for the current language.
(Inherited from CodeDomProvider)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
MemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject)
ParseCompiles the code read from the specified text stream into a CodeCompileUnit.
(Inherited from CodeDomProvider)
SupportsReturns a value indicating whether the specified code generation support is provided.
(Inherited from CodeDomProvider)
ToStringReturns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component)

Events

DisposedOccurs when the component is disposed by a call to the Dispose method.
(Inherited from Component)

See Also