Help with Intellisense and Commenting Code

[JimG]

In Microsofts Application blocks they comment the code directly in front of the Sub or Function, (an example is below).

These commented lines allow the programmer to see the comments and parameters when using that sub/function.

I've tried to do this and I can't get it to work (see my code below). Does anyone have any ideas or know of any
white papers?

Microsofts code

' This method opens (if necessary) and assigns a connection, transaction, command type and parameters
' to the provided command.
' Parameters:
' -command - the OleDbCommand to be prepared
' -connection - a valid OleDbConnection , on which to execute this command
' -transaction - a valid OleDbTransactio n, or ' null'
' -commandType - the CommandType (stored procedure, text, etc.)
' -commandText - the stored procedure name or T-SQL command
' -commandParamete rs - an array of SqlParameters to be associated with the command or ' null' if no parameters are required
Private Shared Sub PrepareCommand( ByVal command As OleDbCommand, _
ByVal connection As OleDbConnection , _
ByVal transaction As OleDbTransactio n, _
ByVal commandType As CommandType, _
ByVal commandText As String, _
ByVal commandParamete rs() As OleDbParameter, ByRef mustCloseConnec tion As Boolean)
My Code

' Executes a Table Search against the table using the provided paramters
' e.g.:
' dim pESADataSet as Core.ISet = oESA.GetData()
' Parameters:
' -WhereClause - A string indicating what the IQueryFilter.Wh ereClause will be set to
' Returns: A Core.ISet containing the results from the table search
Public Overridable Overloads Function GetData(Optiona l ByVal WhereClause As String = Nothing) As Core.ISet

[Shawn D Shelton]

I don't understand your question.

What exactly are you having problems with

The only thing I noticed is that the IDE wants an "end function" on your
GetData function.

What exactly can't you get to work?

Shawn Shelton

JimG wrote:

In Microsofts Application blocks they comment the code directly in front of the Sub or Function, (an example is below).

These commented lines allow the programmer to see the comments and parameters when using that sub/function.

I've tried to do this and I can't get it to work (see my code below). Does anyone have any ideas or know of any
white papers?

Microsofts code

' This method opens (if necessary) and assigns a connection, transaction, command type and parameters
' to the provided command.
' Parameters:
' -command - the OleDbCommand to be prepared
' -connection - a valid OleDbConnection , on which to execute this command
' -transaction - a valid OleDbTransactio n, or ' null'
' -commandType - the CommandType (stored procedure, text, etc.)
' -commandText - the stored procedure name or T-SQL command
' -commandParamete rs - an array of SqlParameters to be associated with the command or ' null' if no parameters are required
Private Shared Sub PrepareCommand( ByVal command As OleDbCommand, _
ByVal connection As OleDbConnection , _
ByVal transaction As OleDbTransactio n, _
ByVal commandType As CommandType, _
ByVal commandText As String, _
ByVal commandParamete rs() As OleDbParameter, ByRef mustCloseConnec tion As Boolean)
My Code

' Executes a Table Search against the table using the provided paramters
' e.g.:
' dim pESADataSet as Core.ISet = oESA.GetData()
' Parameters:
' -WhereClause - A string indicating what the IQueryFilter.Wh ereClause will be set to
' Returns: A Core.ISet containing the results from the table search
Public Overridable Overloads Function GetData(Optiona l ByVal WhereClause As String = Nothing) As Core.ISet

[Chris Dunaway]

On Fri, 7 Nov 2003 09:31:13 -0800, JimG wrote:

In Microsofts Application blocks they comment the code directly in front of the Sub or Function, (an example is below).

These commented lines allow the programmer to see the comments and parameters when using that sub/function.

VB Doesn't directly support comments for intellisense like C# does. There
is an add in available that permits this.

Check this link out for the VB.Net Power Toys which includes this add-in:

http://www.gotdotnet.com/team/ide/

--
Chris

To send me an E-mail, remove the underscores and lunchmeat from my E-Mail
address.

[Herfried K. Wagner [MVP]]

* "=?Utf-8?B?SmltRw==?=" <ji*********@ho tmail.com> scripsit:

In Microsofts Application blocks they comment the code directly in front of the Sub or Function, (an example is below).

These commented lines allow the programmer to see the comments and parameters when using that sub/function.

My XML Comments FAQ:

VB Commenter
<http://www.gotdotnet.c om/team/ide/>
-> section "VB Commenter"

XML Documentation
<http://www.gotdotnet.c om/team/vb/>
-> section "XML Documentation"

VBXC - VB.NET XML Commentor
<http://vbxmldoc.tor-erik.net/index.shtml>

NDOC (formerly DOC.NET)
<http://ndoc.sourceforg e.net/>

VB.DOC
<http://vb-doc.sourceforge .net/>

--
Herfried K. Wagner
MVP · VB Classic, VB.NET
<http://www.mvps.org/dotnet>