C# tag not showing

Question

0.00/5 (No votes)

See more:

My constructor throws an exception. So I tried to add this line above it:

/// <exception cref="System.Exception">Thrown when...
public Person(int serial)
{
if(....)
throw new System.Exception();
}
When I write in Main: Person x = new Person(... it doesn't show what exception this might throw (in the tooltip box). The same problem occurs also with indexer and in properties, if I want to show it only for Set.

If I write it above regular other methods, it does show it.

Thanks in advance

Posted 23-Mar-14 22:46pm

shahed.sohail

Add a Solution

Comments

Raul Iloc 24-Mar-14 7:37am

Why did you UnDo the Acceptance of my solution, because it is solving your problem (I am have using this in many projects)?

2 solutions

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Raul Iloc · Accepted Answer · 2014-03-23T23:22:00

Solution 1

You have to comment your constructor like in the next example:

C#

/// <summary>
/// Your class comment...
/// </summary>
/// <exception cref="AccessViolationException">Your comment...</exception>
public Person(int serial)
{
...
}

Posted 23-Mar-14 23:22pm

Raul Iloc

Comments

shahed.sohail 24-Mar-14 8:20am

Sorry Raul. Maybe by mistake i did.. sorry for it. cheers

OriginalGriff · Accepted Answer · 2014-03-23T23:24:00

If you do not include the information in the XML comments for a method, property, or field, and in the correct format, Visual studio will not pick it up and display it.
For a Constructor, the syntax would be:

C#

/// <summary>
/// Create a person from a serial number
/// </summary>
/// <exception cref="ArgumentException">Thrown when serial number is outside valid range</exception>
/// <param name="serial"></param>
public Person(int serial)
    {
    if (serial == 0)
        {
        throw new ArgumentException("Serial number cannot be zero");
        }
    }

Unfortunately, even with this, exception information isn't displayed in Intellisense for constructors only in the generated documentation files!

[edit]Minor clarification[/edit]