CODEWITHSUNDEEP
delphidelphi-2010
Anton
Anton

Reputation: 31

Code Insight (IntelliSense)

I am trying to add a description to functions I developed - I want this description to display in code insight when another developer is using my units or when a user uses API/COM to connet and uses our software. At the moment all they see is e.g. Function name and return type but they have no idea what the function does exactly.

in C# you use XML tags.

Upvotes: 3

Views: 963

Answers (2)

Mason Wheeler
Mason Wheeler

Reputation: 84550

Marco Cantu has a great blog post about how to use the same system of XML tags that Visual Studio uses to customize HelpInsight.

Upvotes: 3

astorcas
astorcas

Reputation: 281

I'm not sure that's what you need but:

    /// <summary>
    /// 
    /// </summary>
    /// <param name="par1"></param>
    /// <param name="bla"></param>
    /// <param name="foo"></param>
    /// <returns></returns>

Put this above a function declaration (just type the / character three times and visual studio will do the magic) In summary you have to put the description

Upvotes: 1

Related Questions