CODEWITHSUNDEEP
xmlvb.netvisual-studiovisual-studio-2012intellisense
ElektroStudios
ElektroStudios

Reputation: 20484

Issue about XML summary comments in VBNET

Intellisense is not showing my parameter names in blue color like I saw in other xml comments from 3rd party projects where Intellisense prints all the information, this is what I see:

enter image description here

What modifications I need to do in my comments to let intellisense to print the parameter comments in blue as the "returns"?

    ''' <summary>
    ''' Function to pause a thread.
    ''' </summary>
    ''' 
    ''' <param name="Process_Name">The name of the process, ex: cmd.exe</param>
    ''' <param name="Thread_Number">The thread to pause, ex: 0</param>
    ''' <param name="Recursive"> <value name="True">Pause the thread in all processes recursively</value></param>
    ''' <returns>True if the process is found; otherwise, False.</returns>
    Public Shared Function Pause_Thread(ByRef Process_Name As String, _
                              Optional ByVal Thread_Number As Int32 = 0, _
                              Optional ByVal Recursive As Boolean = False) As Boolean

Upvotes: 4

Views: 1039

Answers (2)

smoore4
smoore4

Reputation: 4866

Your XML comments are correctly configured. You will start to see them when you put the first "(" in your code. You can see all of the comments via View; Object Browser. It looks like this:

Public Shared Function Pause_Thread(ByRef Process_Name As String, Optional Thread_Number As Integer = 0, Optional Recursive As Boolean = False) As Boolean

Member of VB_NET_TEST.WebForm1
Summary: Function to pause a thread.

Parameters:
Process_Name: The name of the process, ex: cmd.exe
Thread_Number: The thread to pause, ex: 0
Recursive: Pause the thread in all processes recursively

Return Values:
True if the process is found, otherwise, False.

Remarks:

Upvotes: 2

Mez
Mez

Reputation: 4726

enter image description hereTry to install the Productivity Power Tools addin

From what I see you are looking for the Colorized Parameter Help.

Colorized Parameter Help This extension improves consistency with the editor by applying syntax highlighting to the contents of the Parameter Help window for C# &VB. Please note: Syntax highlighting colors can be customized using the display items prefixed with “Signature Help” in the “Fonts and Colors” menu.

Try Tools->Options->Environment->Fonts and Colors->Signature Help Tooltip Background.

Upvotes: 6

Related Questions