Click here to Skip to main content
12,353,170 members (68,390 online)
Click here to Skip to main content
Articles » Database » Database » SQL » Downloads

Stats

68.3K views
1.1K downloads
74 bookmarked
Posted

SQL XML Documentation

, 29 Feb 2008 CPOL
How to create and compile SQL XML Documentation comments
DatabaseToXml
bin
Debug
JocysCom.Sql.DatabaseToXml.exe
JocysCom.Sql.DatabaseToXml.vshost.exe
JocysCom.Sql.DatabaseToXml.vshost.exe.manifest
JocysCom.Sql.XmlDocumentation.dll
JocysCom.Sql.DatabaseToXml.csproj.user
Properties
Resources
WinApp
bin
Debug
Interop.ADODB.dll
Interop.CDO.dll
JocysCom.ClassLibrary.dll
JocysCom.Sql.ScriptsGenerator.exe
JocysCom.Sql.ScriptsGenerator.vshost.exe
JocysCom.Sql.ScriptsGenerator.vshost.exe.manifest
JocysCom.Sql.XmlDocumentation.dll
Microsoft.Data.ConnectionUI.Dialog.dll
Microsoft.Data.ConnectionUI.dll
Microsoft.SqlServer.ConnectionInfo.dll
Microsoft.SqlServer.SqlEnum.dll
Controls
GenerateActionScripts
Jocys.com SQL Scripts Generator.csproj.user
Properties
XmlDocumentation
bin
Debug
JocysCom.Sql.XmlDocumentation.dll
JocysCom.Sql.XmlDocumentation.csproj.user
Properties
SQL Scripts Generator.suo
using System;
using System.Collections.Generic;
using System.Text;

namespace JocysCom.Sql.XmlDocumentation
{
	/// <summary>
	/// Recommended Tags for Documentation Comments:
	/// http://msdn2.microsoft.com/en-us/library/2d6dt3kf(VS.80).aspx
	/// </summary>
	public struct Tags
	{
		/// <summary>
		/// Specify an example of how to use a method or other library member.
		/// </summary>
		public const string Example = "example";
		/// <summary>
		/// Specify which exceptions can be thrown.
		/// </summary>
		public const string Exception = "exception";
		/// <summary>
		/// Refer to comments in another file that describe the types and members in your source code.
		/// </summary>
		public const string Include = "include";
		/// <summary>
		///  Define the heading row of either a table or definition list.
		/// </summary>
		public const string List = "list";
		/// <summary>
		/// Paragraph tag lets you add structure to the text.
		/// </summary>
		public const string Para = "para";
		/// <summary>
		/// A description for the parameter.
		/// </summary>
		public const string Param = "param";
		/// <summary>
		/// Document the access of a member.
		/// </summary>
		public const string Permission = "permission";
		/// <summary>
		/// Information about a type, supplementing the information specified with summary.
		/// </summary>
		public const string Remarks = "remarks";
		/// <summary>
		/// Describe the return value.
		/// </summary>
		public const string Returns = "returns";
		/// <summary>
		/// Specify a link from within text.
		/// </summary>
		public const string See = "see";
		/// <summary>
		/// Specify the text that you might want to appear in a See Also section.
		/// </summary>
		public const string SeeAlso = "seealso";
		/// <summary>
		/// Describe a type or a type member.
		/// </summary>
		public const string Summary = "summary";
		/// <summary>
		/// Comment for a generic type or method declaration to describe a type parameter.
		/// </summary>
		public const string TypeParam = "typeparam";
		/// <summary>
		/// Describe the value that a property represents.
		/// </summary>
		public const string Value = "value";

	}

	public struct SubTags
	{
		/// <summary>
		/// The text you would like to indicate as code.
		/// </summary>
		public const string C = "c";
		/// <summary>
		/// Mark multiple line text as code.
		/// </summary>
		public const string Code = "code";
		/// <summary>
		/// Define the heading row of either a table or definition list.
		/// </summary>
		public const string ListHeader = "listheader";
		/// <summary>
		/// Specify each item in the list. 
		/// </summary>
		public const string Item = "item";
		/// <summary>
		/// A term to define, which will be defined in description.
		/// </summary>
		public const string Term = "term";
		/// <summary>
		/// Either an item in a bullet or numbered list or the definition of a term.
		/// </summary>
		public const string Description = "description";
		/// <summary>
		/// Indicate that a word in the code comments refers to a parameter.
		/// </summary>
		public const string ParamRef = "paramref";
		/// <summary>
		/// Indicate that a word in the code comments refers to a type parameter.
		/// </summary>
		public const string TypeParamRef = "typeparamref";
	}

	
}

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, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

EJocys
Software Developer (Senior)
United Kingdom United Kingdom
No Biography provided

You may also be interested in...

| Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.160621.1 | Last Updated 29 Feb 2008
Article Copyright 2007 by EJocys
Everything else Copyright © CodeProject, 1999-2016
Layout: fixed | fluid