Ing Informatico

CodeSmith User's Guide |

CodeSmith User's Guide

CodeSmith is a template-based code generator that can produce code for any text-based language. Whether your target language is C#, Visual Basic .NET, T-SQL, Java or even FORTRAN, CodeSmith can help you produce higherquality, more consistent code in less time than writing code by hand. CodeSmith's familiar ASP.NET-based template syntax meansthat you can be writing your first templates within minutes of installing the package. The advanced CodeSmith Studio (Section 6.1) integrated development environment (IDE) helps you create and test new templates in a rapid development setting. You can also join in CodeSmith's active online community (http://community.codesmithtools.com/forums/) to download hundreds of ready-made templates for suchcommon development tasks as building strongly-type collection classes or creating data access layers.

CodeSmith Projects (Section 4.3) and ActiveSnippets (Section 8.1) are integrated within Visual Studio to make code generation a breeze.
CodeSmith also includes a console version (Section 11.1) and an MSBuild task that you can easily integrate into your automated build process, flexiblestrategies for merging generated code (Section 12.2.1) with custom code, the SchemaExplorer API (Section 10.3.1) for integration with relational data sources, and the ability to hook up your own custom metadata sources (Section 10.5.1). If you're new to CodeSmith, Getting Started with CodeSmith (Section 2.3.2.1) will show you how to begin generating code for your own projects immediately. If you're anexperienced CodeSmith user, What's New (Section 2.2) will point you at the major new features in this release.

CodeSmith User's Guide |

Table of Contents
1. 2. Welcome to CodeSmith Introduction and Tutorials 2.1. CodeSmith's Main Features 2.2. What's New 2.3. Tutorials 2.3.1. Working with CodeSmith 2.3.2. Getting Started with CodeSmith 2.3.2.1. Getting Started with CodeSmith 2.3.2.2.Launching CodeSmith Explorer 2.3.2.3. Opening a Template 2.3.2.4. Setting Properties 2.3.2.5. Generating Code 2.3.2.6. Inspecting the Template 2.3.2.7. Where to Go From Here 2.3.3. Writing Your First Template 2.3.3.1. Writing Your First Template 2.3.3.2. Spotting the Need 2.3.3.3. Creating the Template 2.3.3.4. Start with the Result 2.3.3.5. Static Content in the Template 2.3.3.6. Making the ContentDynamic 2.3.3.7. Adding Property Directives 2.3.3.8. Using Properties in the Template 2.3.3.9. Compiling the Template and Generating Code 2.3.4. Writing a Template with Database Metadata 2.3.4.1. Writing a Template with Database Metadata 2.3.4.2. HTTP Endpoints in SQL Server 2005 2.3.4.3. The Desired SQL Statements 2.3.4.4. Creating the Template in CodeSmith Studio 2.3.4.5. Setting up EnumeratedProperties 2.3.4.6. Setting up a SQL Property 2.3.4.7. Writing the Database Code 2.3.4.8. Testing the Final Result 1 2 2 2-6 6 6 6 6 6-7 7-9 9-10 10-11 11-12 12 12 12 12-13 13 13-14 14 14-15 15 15-16 16-17 17 17 17 17-18 18-19 19-21 21 21-23 23-25

CodeSmith User's Guide | 3. Using CodeSmith Explorer 3.1. What is CodeSmith Explorer? 3.2. The CodeSmith Explorer Toolbar 3.3. Managing the Folder Tree3.4. Editing Templates 3.5. Executing Templates 3.6. Working with the Output Panel 4. Visual Studio Integration 4.1. Visual Studio Integration 4.2. CodeSmith Explorer in Visual Studio 4.3. Using a CodeSmith Project inside Visual Studio 5. Basic Template Syntax 5.1. The CodeTemplate Directive 5.2. Including Comments 5.3. Declaring and Using Properties 5.3.1. Declaring and Using Properties 5.3.2.Declaring a Simple Property 5.3.3. Declaring an Enumerated Property 5.3.4. Property Validation 5.4. Escaping ASP.NET Tags 5.5. The CodeSmith Objects 5.5.1. The CodeSmith Objects 5.5.2. The CodeTemplate Object 5.5.2.1. The CodeTemplate Object 5.5.2.2. Overriding the GetFileName Method 5.5.2.3. Overriding the ParseDefaultValue Method 5.5.2.4. Overriding the Render Method 5.5.2.5. Template Events...