XML Comments (1 Viewer)

[RonPaii]

I have been adding XML style comments to my procedure headers for a more structured comment system. It would be great if MS could enhance VBA, to use them in intellisence like in .NET.

''' <summary>
''' Check if user is member of an Active Directory group
''' </summary>
''' <param name="AdGroupName">Name of AD group to check.</param>
''' <param name="UserWinID">User ID to check, Current if empty.</param>
''' <param name="oUseConnection">Existing connection, else use new.</param>
''' <returns>True if user in group and no error.</returns>
Public Function ADGroupMember( _
                ByVal AdGroupName As String, _
                Optional ByVal UserWinID As String = vbNullString, _
                Optional oUseConnection As ADODB.Connection = Nothing) As Boolean

 

[tvanstiphout]

MzTools has a pretty nice one; fully configurable. Best 100 bucks I ever spent.

' ----------------------------------------------------------------
' Procedure Name: $P[CODE_ELEMENT_NAME]
' Purpose: $U[Procedure Purpose]
' Procedure Kind: $P[CODE_ELEMENT_KIND_DESCRIPTION]
' Procedure Access: $P[CODE_ELEMENT_ACCESS_KEYWORD]
$P[PARAMETER_SECTION_BEGIN]' Parameter $P[PARAMETER_NAME] ($P[PARAMETER_TYPE_NAME]): $U[Parameter purpose]
$P[PARAMETER_SECTION_END]$P[METHOD_RETURN_SECTION_BEGIN]' Return Type: $P[METHOD_RETURN_TYPE_NAME]
$P[METHOD_RETURN_SECTION_END]' Author: $P[AUTHOR]
' Date: $P[DATE]
' ----------------------------------------------------------------

 

[DaveMD]

MZ-Tools is a great tool for MS Access development. I use the function header feature frequently. It could be customized easily to format the header in xml format. I understand the OP is also referring to how Visual Studio DotNet then uses the xml header when calling the function to show intellisense popups with the description of the function and parameters (like in the screenshot below). That would be useful if the VBA Editor had something like that. Unfortunately, it's probably unlikely MS will put any resources to adding it.