[RESOLVED] Tooltip description

[ComputerJy]

Hey all,

I was wondering "how can I set tooltip description for my methods and vars like .NET ready classes?"

another thing, what's "3.0/LINQ"?

[sunburnt]

Use the XML comments to create tooltips for your functions and classes.

If you put /// on top of a function or class name, it should auto-generate some fields for you.

Here's an example.

        /// <summary>
        /// Provides the ability to seek on the internal buffer
        /// as well as both the Reader and Writer.
        /// </summary>
        /// <param name="offset">The new position within the stream, relative to the location.  This can be positive or negative</param>
        /// <param name="loc">The seek reference point.</param>
        public void Seek(long offset, SeekOrigin loc)
        {
                ms.Seek(offset, loc);
        }

[jmcilhinney]

You need to add XML comment blocks to your property and method declarations and then enable the XML documentation file in the project properties under Build -> Output. Place your cursor before or above a declaration, type three slashes and hit enter. Voila.

C# 3.0 is the version of the C# language that will be released to coincide with version 3.0 of the .NET Framework. LINQ is what MSDN says it is. MSDN is the first place to go for any query relating to Microsoft development.

http://msdn.microsoft.com/vcsharp/future/default.aspx

[ComputerJy]

So, does that mean that it's not doable in VB?

[jmcilhinney]

In VB you use three single quotes instead of three slashes. The functionality is built into VB 2005 but VB.NET 2003 requires a plug-in. You also don't need to specify a documentation file in VB. It automatically creates MyApp.xml where MyApp.exe would be your assembly. Note that you can also use a tool like NDoc to generate MSDN-style help files for your assemblies from these XML files. You'd normally only do that for libraries though.

[ComputerJy]

Thank you all very much