Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

C# Bullet list in PARAM section of code documentation

Tags:

c#

For a function parameter, I want to use a list of options in the code documentation.

For the <summary> tag, this is no problem (Microsoft Docs). But how do I make a bullet list for a <param> tag? The example below doesn't create a list in the quickview window while programming:

<param name="Type list">
<list type= "bullet">
<item><description>Item description</description></item>
</list>
</param>
like image 865
Quispie Avatar asked Dec 04 '14 10:12

Quispie


People also ask

What C is used for?

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 full name of C?

In the real sense it has no meaning or full form. It was developed by Dennis Ritchie and Ken Thompson at AT&T bell Lab. First, they used to call it as B language then later they made some improvement into it and renamed it as C and its superscript as C++ which was invented by Dr.

Is C language easy?

Compared to other languages—like Java, PHP, or C#—C is a relatively simple language to learn for anyone just starting to learn computer programming because of its limited number of keywords.

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.


2 Answers

This works fine.

I tried this code:

public class Program
{
    /// <summary>The summary</summary>
    /// <param name="args">
    /// The command-line arguments.
    /// <list type="bullet">
    /// <item><description>Item 1</description></item>
    /// <item><description>Item 2</description></item>
    /// <item><description>Item 3</description></item>
    /// </list>
    /// </param>

    public static void Main(string[] args)
    {
    }
}

Then I used Sandcastle to produce a help file which looks like this:

Output Documentation

As you can see, the bulleted list appears correctly for the parameter.

This is how Resharper shows the tooltip:

Resharper shows a bulleted list

like image 130
Matthew Watson Avatar answered Sep 20 '22 14:09

Matthew Watson


Bullet list didn't work for me, perhaps because I want to add it for a class property. Use <para> for that, like this:

public class Program
{
    /// <summary>
    /// Main comment.
    /// <para>List 1 :</para>
    /// <para>- Item 1</para>
    /// <para>- Item 2</para>
    /// <para>- Item 3</para>
    /// <para>- Item..n</para>       
    /// </summary>
    public string property1 { get; set; }
}
like image 34
Shrikant Dandile Avatar answered Sep 20 '22 14:09

Shrikant Dandile