Including comments

Template comments

To add a comment to a CodeSmith Generator template, surround it with <%-- and --%>. Comments can span multiple lines and have no effect on the output:

<%--
Name: TestHarness.cst
Description: Generates a standard test harness for an object
--%>

Template comments are the only thing allowed before the CodeTemplate directive, which makes them a good place for a header that describes the template.

Comments in script blocks

Inside code blocks and <script runat="template"> blocks, use the comment syntax of the template's language. For example, in a C# template, use // or /* ... */.

Comments in the generated code

To put a comment in the generated output, write it like any other static text. The comment in this template fragment is copied directly to the generated code:

<%@ CodeTemplate Language="VB" TargetLanguage="VB" %>
' This class generated by CodeSmith Generator