dotnetframework/System.CodeDomv9.0.2
✓ Verified.NET FW4.6.2.NET 10.0.NET 11.0.NET Std2.0
Provides types that can be used to model the structure of a source code document and to output source code for that model in C# or Visual Basic.
Get Started
$ dotnet add package System.CodeDomReadme
About
Provides functionality for dynamically generating and compiling source code using the Code Document Object Model (CodeDOM).
It allows developers to represent code in a language-agnostic format and then generate code in multiple languages, such as C# and VB.NET. The primary use cases include creating dynamic code generation tools, runtime code generation, and facilitating code analysis or transformation.
For a new modern development consider using the .NET Compiler Platform SDK, in particular Roslyn source generators.
Key Features
- Write code using a common object model that can be translated into multiple programming languages.
- Generate and compile code at runtime based on the CodeDOM.
How to Use
Generating and compiling C# code:
using System.CodeDom;
using System.CodeDom.Compiler;
using Microsoft.CSharp;
// Create a new CodeCompileUnit to hold the code
var compileUnit = new CodeCompileUnit();
// Create a namespace
var codeNamespace = new CodeNamespace("MyNamespace");
compileUnit.Namespaces.Add(codeNamespace);
// Create a class
var classDeclaration = new CodeTypeDeclaration("MyClass")
{
IsClass = true
};
codeNamespace.Types.Add(classDeclaration);
// Add a simple method to the class
var method = new CodeMemberMethod
{
Name = "HelloWorld",
ReturnType = new CodeTypeReference(typeof(void)),
};
classDeclaration.Members.Add(method);
var methodInvocation = new CodeMethodInvokeExpression(new CodeTypeReferenceExpression("Console"),
"WriteLine",
new CodePrimitiveExpression("Hello, World!"));
method.Statements.Add(methodInvocation);
// Generate C# code from the CodeDOM structure
CodeDomProvider provider = new CSharpCodeProvider();
using (var writer = new StringWriter())
{
var codeGenereationOptions = new CodeGeneratorOptions()
{
BlankLinesBetweenMembers = false,
IndentString = " ",
};
provider.GenerateCodeFromCompileUnit(compileUnit, writer, codeGenereationOptions);
Console.WriteLine(writer.GetStringBuilder().ToString());
}