David DB
asked on
The documentation feature and intellisense tooltip
I'm documenting my code, and have a question regarding the intellisense tooltip.
If my commenting is this:
The tooltip will only show the summary, and for each parameter.
Is there a way of showing more in the tooltip ? Like see cref and returns ?
If my commenting is this:
/// <summary>
/// Creates a customer and returns the new id. Negative error number.
/// </summary>
/// <param name="newCustomer">Customer object to be created.</param>
/// <returns>Id of created customer. Negative if error.</returns>
/// See <see cref="Customer"/> for the object.
/// See <seealso cref="GetCustomer(long)"/> to get the object.
The tooltip will only show the summary, and for each parameter.
Is there a way of showing more in the tooltip ? Like see cref and returns ?
Last Comment
Chinmay Patel
Of course you can, here is a complete list of possible tags. Please click on See, SeeAlso and Returns for specific guidance.
ASKER
I know the possible tags.
The question was how to make the intellisense tooltip show more than three lines it does (at least in my visual studio).
Would like to see the other comment properties also.
The question was how to make the intellisense tooltip show more than three lines it does (at least in my visual studio).
Would like to see the other comment properties also.
Oh sorry. I misinterpreted your question. Can you post a screenshot please.
ASKER
The behavior of VS is to not show those items. Those particular items that you mention, as well as a couple of others, are typically used by documentation generators (e.g. Sandcastle) and output in the resulting file(s).
There may be a plugin that can override the default VS behavior--Resharper might do this, I can't remember.
There may be a plugin that can override the default VS behavior--Resharper might do this, I can't remember.
ASKER CERTIFIED SOLUTION
THIS SOLUTION IS ONLY AVAILABLE TO MEMBERS.
View this solution by signing up for a free trial.
Members can start a 7-Day free trial and enjoy unlimited access to the platform.
Yupp. Per current documentation,
https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/remarks
https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/remarks
The <remarks> tag is used to add information about a type, supplementing the information specified with <summary>. This information is displayed in the Object Browser window.
Compile with -doc to process documentation comments to a file.
C#
C# is an object-oriented programming language created in conjunction with Microsoft’s .NET framework. Compilation is usually done into the Microsoft Intermediate Language (MSIL), which is then JIT-compiled to native code (and cached) during execution in the Common Language Runtime (CLR).
98K
Questions
--
Followers
--
Top Experts
Get a personalized solution from industry experts
TRUSTED BY
