Summary

  • Thread starter Thread starter Rodrigo Ferreira
  • Start date Start date
R

Rodrigo Ferreira

What's is the beneficts or the finality of:

/// <summary>

///

/// </summary>
 
Hi,

The IDE's intellisente display it in a small yellow area below the method, you can describe what the method does, a similar approach with the parameters

cheers,

--
Ignacio Machin,
ignacio.machin AT dot.state.fl.us
Florida Department Of Transportation



What's is the beneficts or the finality of:

/// <summary>

///

/// </summary>
 
I wrote something bu doesn' appear! My project is a UserControl!

/// <summary>

/// TEST

///

public void InitTest()

{

(....)

}



"Ignacio Machin ( .NET/ C# MVP )" <ignacio.machin AT dot.state.fl.us> wrote in message Hi,

The IDE's intellisente display it in a small yellow area below the method, you can describe what the method does, a similar approach with the parameters

cheers,

--
Ignacio Machin,
ignacio.machin AT dot.state.fl.us
Florida Department Of Transportation



What's is the beneficts or the finality of:

/// <summary>

///

/// </summary>
 
IF you tell it to generate XML documentation files first:

Project properties > Configuration Properties > Build
then as "XML Documentation File" a filename to an xml document,
where the documentation will be generated.

We use as filename:
- same directory as the "Output Path" (see one line higher)
- filename equal to the project name (or assembly name)
- extension .xml

and then REbuild the project or solution.

Hans Kesting

"Ignacio Machin ( .NET/ C# MVP )" <ignacio.machin AT dot.state.fl.us> wrote in message Hi,

The IDE's intellisente display it in a small yellow area below the method, you can describe what the method does, a similar approach with the parameters

cheers,

--
Ignacio Machin,
ignacio.machin AT dot.state.fl.us
Florida Department Of Transportation



What's is the beneficts or the finality of:

/// <summary>

///

/// </summary>
 
Rodrigo,

You need to have the closing tag for the XML to be valid, like so:

/// <summary>
/// TEST
/// </summary>
public void InitTest()

Hope this helps.


--
- Nicholas Paldino [.NET/C# MVP]
- (e-mail address removed)

I wrote something bu doesn' appear! My project is a UserControl!

/// <summary>
/// TEST
///
public void InitTest()
{
(....)
}

"Ignacio Machin ( .NET/ C# MVP )" <ignacio.machin AT dot.state.fl.us> wrote
in message Hi,

The IDE's intellisente display it in a small yellow area below the method,
you can describe what the method does, a similar approach with the
parameters

cheers,

--
Ignacio Machin,
ignacio.machin AT dot.state.fl.us
Florida Department Of Transportation



What's is the beneficts or the finality of:

/// <summary>
///
/// </summary>
 
It's perfect Hans!

Thanks!
IF you tell it to generate XML documentation files first:

Project properties > Configuration Properties > Build
then as "XML Documentation File" a filename to an xml document,
where the documentation will be generated.

We use as filename:
- same directory as the "Output Path" (see one line higher)
- filename equal to the project name (or assembly name)
- extension .xml

and then REbuild the project or solution.

Hans Kesting

"Ignacio Machin ( .NET/ C# MVP )" <ignacio.machin AT dot.state.fl.us> wrote in message Hi,

The IDE's intellisente display it in a small yellow area below the method, you can describe what the method does, a similar approach with the parameters

cheers,

--
Ignacio Machin,
ignacio.machin AT dot.state.fl.us
Florida Department Of Transportation



What's is the beneficts or the finality of:

/// <summary>

///

/// </summary>
 
Back
Top