Click here to Skip to main content
Click here to Skip to main content
Articles » Languages » C# » Attributes » Downloads
 
Add your own
alternative version
Go to top

Make NDoc compile the code examples contained in your documentation using NLiterate

, 26 Apr 2004
An utility that merges and recompiles the examples in your documentation using NDoc.
using System;

namespace NLiterate.Demo
{
	/// <summary>
	/// A simple example of literate documentation.
	/// </summary>
	/// <remarks>
	/// <code id="entry" entry-point="true" language="cs" compilable="true" hidden-namespace="Test">
	/// using System;
	/// 
	/// public class HelloWorld
	/// {
	///     public static void Main()
	///     {
	///         {[consoleout Testing console out here]}
	///     }
	/// }
	/// </code>
	/// blablab
	/// <code id="consoleout">
	/// Console.WriteLine("Hello world");
	/// </code>
	/// </remarks>
	public class HelloWorld
	{
		public HelloWorld()
		{
			//
			// TODO: Add constructor logic here
			//
		}
	}
}

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Share

About the Author

Jonathan de Halleux
Engineer
United States United States
Jonathan de Halleux is Civil Engineer in Applied Mathematics. He finished his PhD in 2004 in the rainy country of Belgium. After 2 years in the Common Language Runtime (i.e. .net), he is now working at Microsoft Research on Pex (http://research.microsoft.com/pex).

| Advertise | Privacy | Mobile
Web02 | 2.8.140916.1 | Last Updated 27 Apr 2004
Article Copyright 2004 by Jonathan de Halleux
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid