Documentation Comments for class : Documentation Comments « Language Basics « C# / CSharp Tutorial

1.	Language Basics
2.	Data Type
3.	Operator
4.	Statement
5.	String
6.	struct
7.	Class
8.	Operator Overload
9.	delegate
10.	Attribute
11.	Data Structure
12.	Assembly
13.	Date Time
14.	Development
15.	File Directory Stream
16.	Preprocessing Directives
17.	Regular Expression
18.	Generic
19.	Reflection
20.	Thread
21.	I18N Internationalization
22.	LINQ
23.	GUI Windows Forms
24.	Windows Presentation Foundation
25.	Windows Communication Foundation
26.	Workflow
27.	2D
28.	Design Patterns
29.	Windows
30.	XML
31.	XML LINQ
32.	ADO.Net
33.	Network
34.	Directory Services
35.	Security
36.	unsafe

C# / C Sharp

C# / C Sharp by API

C# / CSharp Open Source

C# / CSharp Tutorial » Language Basics » Documentation Comments

1.2.1.Documentation Comments for class

using System;



namespace DocumentationCommentsExample

{

    /// <summary>

    /// A documentation sample - the short description goes here

    /// </summary>

    /// <remarks>Where a longer description would go</remarks>

    class ClassExample

    {

    }

}

1.2.Documentation Comments
	1.2.1.	Documentation Comments for class
	1.2.2.	Documentation Comments for A member variable
	1.2.3.	Documentation Comments for A property
	1.2.4.	Documentation Comments for a method with parameters
	1.2.5.	Documentation Comments for Main function
	1.2.6.	Compiler Support Tags
	1.2.7.	XML Documentation
	1.2.8.	Recommended Code Comment XML Elements

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.