Question Best way for generate documentation in vb dot net 3.0/3.5

nelson.enlis

Member
Joined
Feb 16, 2009
Messages
8
Programming Experience
Beginner
Hi,

Exist some way of to comment (documenting) my code (constructors, methods, properties, etc) ?

I'm learning how to comment in the same code.

HTML:
<summary> ... </summary>

Here a example
VB.NET:
    ''' <summary>
    ''' busca una fila o conjunto de filas de acurdo a un critero WHERE
    ''' </summary>
    ''' <param name="CampoBusqueda">Nombre del campo de la tabla SQL a buscar</param>
    ''' <param name="CadenaBusqueda">Cadena de texto que utilizara en la sentencia WHERE a encontrar en el Campo de busqueda</param>
    ''' <returns>Retorna True si la busqueda tuvo suceso. de lo contrario retornara False</returns>
    ''' <remarks></remarks>
    Public Function Buscar(ByVal CampoBusqueda As String, ByVal CadenaBusqueda As String) As Boolean
        Dim c As Integer

        cmdStr = "SELECT COUNT(*) FROM " + dt.TableName + " WHERE " + CampoBusqueda + " LIKE '" + CadenaBusqueda + "'"
        cmd.CommandText = cmdStr

        Try
            con.Open()
            c = cmd.ExecuteScalar()
            con.Close()

            If (c = 0) Then
                Return False
            Else
                Return True
            End If
        Catch ex As Exception
        Finally
            con.Close()
        End Try

    End Function


So, I try with many GUI that make this work "automaticly", for example:
. SandCastle (and SandCastle Builder)
. DocProject External UI
. Innovasys HelpStudio Lite


The first, after many tries, does work. But with error, because my comment not appear in the .chm generate file.

The second, doesn't work.

And the third, seems better, but I'm not found a method (how SandCastle) of import the project .vbporj for make the documentation.

Anyway ... I'm not sure if this tools be the better option or if dot net 3.5 provide a native method for do this job.

some Help ?

Best Regards
 
Back
Top