Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

What are the C# documentation tags? [closed]

In C# documentation tags allow you to produce output similar to MSDN. What are a list of allowable tags for use inside the /// (triple slash) comment area above classes, methods, and properties?

like image 468
Kevin Driedger Avatar asked Sep 15 '08 19:09

Kevin Driedger


People also ask

What is C language?

C is an imperative procedural language supporting structured programming, lexical variable scope, and recursion, with a static type system. It was designed to be compiled to provide low-level access to memory and language constructs that map efficiently to machine instructions, all with minimal runtime support.

What is C and its uses?

C programming language is a machine-independent programming language that is mainly used to create many types of applications and operating systems such as Windows, and other complicated programs such as the Oracle database, Git, Python interpreter, and games and is considered a programming foundation in the process of ...

What is the main point of C?

One of the most significant features of C language is its support for dynamic memory management (DMA). It means that you can utilize and manage the size of the data structure in C during runtime. C also provides several predefined functions to work with memory allocation.


2 Answers

If you type this just above a method or class, intellisense should prompt you with a list of available tags:

/// < 
like image 77
Joel Coehoorn Avatar answered Sep 23 '22 20:09

Joel Coehoorn


Here's a list:

  • summary
  • param
  • returns
  • example
  • code
  • see
  • seealso
  • list
  • value
  • file
  • copyright

Here's an example:

 <file> <copyright>(c) Extreme Designers Inc. 2008.</copyright> <datecreated>2008-09-15</datecreated> <summary> Here's my summary </summary> <remarks> <para>The <see cref="TextReader"/> can be used in the following ways:</para> <list type="number"> <item>first item</item> <item>second item</item> </list> </remarks> <example> <code> System.Console.WriteLine("Hello, World"); </code> </example> <param name="aParam">My first param</param> <returns>an object that represents a summary</returns> </file> 
like image 20
Kevin Driedger Avatar answered Sep 26 '22 20:09

Kevin Driedger