CSharpCodeProviderWithDocs Class

EWSoftware.CodeDom

previous page next page

EWSoftware.CodeDom Namespace Documentation

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

Inheritance Hierarchy

SystemObject  SystemMarshalByRefObject
    System.ComponentModelComponent
      System.CodeDom.CompilerCodeDomProvider
        Microsoft.CSharpCSharpCodeProvider
          EWSoftware.CodeDomCSharpCodeProviderWithDocs

Namespace: EWSoftware.CodeDom
Assembly: EWSoftware.CodeDom (in EWSoftware.CodeDom.dll) Version: 2015.6.7.0

Syntax

C++

Copy

public class CSharpCodeProviderWithDocs : CSharpCodeProvider

Public Class CSharpCodeProviderWithDocs
	Inherits CSharpCodeProvider

public ref class CSharpCodeProviderWithDocs : public CSharpCodeProvider

type CSharpCodeProviderWithDocs =  
    class
        inherit CSharpCodeProvider
    end

The CSharpCodeProviderWithDocs type exposes the following members.

Constructors

	Name	Description
	CSharpCodeProviderWithDocs	Default constructor
	CSharpCodeProviderWithDocs(IDictionaryString, String)	This constructor is passed a provider options dictionary

Top

Properties

	Name	Description
	CanRaiseEvents	Gets a value indicating whether the component can raise an event. (Inherited from Component.)
	Container	Gets the IContainer that contains the Component. (Inherited from Component.)
	DesignMode	Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
	Events	Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
	FileExtension	Gets the file name extension to use when creating source code files. (Inherited from CSharpCodeProvider.)
	LanguageOptions	Gets a language features identifier. (Inherited from CodeDomProvider.)
	Site	Gets or sets the ISite of the Component. (Inherited from Component.)

Top

Methods

	Name	Description
	CompileAssemblyFromDom	Compiles 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).)
	CompileAssemblyFromFile	Compiles an assembly from the source code contained in the specified files, using the specified compiler settings. (Overrides CodeDomProviderCompileAssemblyFromFile(CompilerParameters, String).)
	CompileAssemblyFromSource	Compiles an assembly from the specified array of strings containing source code, using the specified compiler settings. (Overrides CodeDomProviderCompileAssemblyFromSource(CompilerParameters, String).)
	CreateCompiler	Obsolete. Gets an instance of the C# code compiler. (Inherited from CSharpCodeProvider.)
	CreateEscapedIdentifier	Creates an escaped identifier for the specified value. (Inherited from CodeDomProvider.)
	CreateGenerator	Obsolete. Gets an instance of the C# code generator. (Inherited from CSharpCodeProvider.)
	CreateGenerator(TextWriter)	When overridden in a derived class, creates a new code generator using the specified TextWriter for output. (Inherited from CodeDomProvider.)
	CreateGenerator(String)	When overridden in a derived class, creates a new code generator using the specified file name for output. (Inherited from CodeDomProvider.)
	CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
	CreateParser	Obsolete. When overridden in a derived class, creates a new code parser. (Inherited from CodeDomProvider.)
	CreateValidIdentifier	Creates a valid identifier for the specified value. (Inherited from CodeDomProvider.)
	Dispose	Releases 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.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
	GenerateCodeFromCompileUnit	Generates 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.)
	GenerateCodeFromExpression	Generates 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.)
	GenerateCodeFromMember	Generates code for the specified class member using the specified text writer and code generator options. (Inherited from CSharpCodeProvider.)
	GenerateCodeFromNamespace	Generates 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.)
	GenerateCodeFromStatement	Generates 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.)
	GenerateCodeFromType	Generates 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.)
	GetConverter	Gets a TypeConverter for the specified type of object. (Inherited from CSharpCodeProvider.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetService	Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetTypeOutput	Gets the type indicated by the specified CodeTypeReference. (Inherited from CodeDomProvider.)
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	IsValidIdentifier	Returns a value that indicates whether the specified value is a valid identifier for the current language. (Inherited from CodeDomProvider.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	Parse	Compiles the code read from the specified text stream into a CodeCompileUnit. (Inherited from CodeDomProvider.)
	Supports	Returns a value indicating whether the specified code generation support is provided. (Inherited from CodeDomProvider.)
	ToString	Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)

Top

Events

	Name	Description
	Disposed	Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

Top

Remarks

This changes the default behavior which overwrites the comments file on each invocation and dumps it 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.

Examples

Example Compiler Configuration

Copy

<configuration>
    <system.codedom>
      <compilers>
        <!-- For C# -->
        <compiler language="c#;cs;csharp" extension=".cs"
          compilerOptions="/docpath:C:\Publish\Doc"
          type="EWSoftware.CodeDom.CSharpCodeProviderWithDocs,
              EWSoftware.CodeDom, Version=1.0.0.0, Culture=neutral,
              PublicKeyToken=d633d7d5b41cbb65" />
      </compilers>
    </system.codedom>
</configuration>

Reference

EWSoftware.CodeDom Namespace

Send comments on this topic to [email protected]

previous page start next page