Parameter Description in Code Completion

  • Thread starter Thread starter Anthony Bouch
  • Start date Start date
A

Anthony Bouch

I have a couple of helper class libraries that I use in several projects.

Does anyone know how to create the parameter description that appears below
the parameter autocomplete popup when a method in the helper class is being
used in Visual Studio?

Is there a meta tag for this?

At the moment the parameter list appears the yellow popup window but no
parameter description is displayed below.

Any tips greatly apprecated.

Tony
 
Anthony Bouch said:
I have a couple of helper class libraries that I use in several projects.

Does anyone know how to create the parameter description that appears below
the parameter autocomplete popup when a method in the helper class is being
used in Visual Studio?
Click to expand...

Use the <parameter> XML documentation tag. See XML Documentation in the
MSDN index for more information.
 
/// <summary>
/// Helper method description etc...
/// </summary>
/// <param name="form">Form parameter.</param>
/// <param name="offset">POffset Parameter </param>
public static void PositionForm(System.Windows.Forms.Form form, float
offset)
{
...

Hi Jon - I've tried the above but the parameter comments still don't appear
as hints in the auto complete popup for the method. Any suggestions

Regards,

Tony
 
Anthony Bouch said:
/// <summary>
/// Helper method description etc...
/// </summary>
/// <param name="form">Form parameter.</param>
/// <param name="offset">POffset Parameter </param>
public static void PositionForm(System.Windows.Forms.Form form, float
offset)
{
...

Hi Jon - I've tried the above but the parameter comments still don't appear
as hints in the auto complete popup for the method. Any suggestions
Click to expand...

Do you get *any* hints (i.e. about class usage etc) beyond what can be
inferred without the XML? Are these libraries part of the same solution
or not? Are you building the XML documentation (with the same name as
the assembly, but with .xml instead of .dll)?
 
Yes - I get the hints for the method which shows the data types and variable
names required for the parameters. But no parameter description.

This class is combiled as a DLL - and it is then referenced (and copied
local) by the calling Windows forms project.

I'm not actually building any XML documentation at all - do I need to?
 
Anthony Bouch said:
Yes - I get the hints for the method which shows the data types and variable
names required for the parameters. But no parameter description.

This class is combiled as a DLL - and it is then referenced (and copied
local) by the calling Windows forms project.

I'm not actually building any XML documentation at all - do I need to?
Click to expand...

Yes - otherwise it's got nothing to get the information from.
 
Back
Top