Poner Descripcion en Declaracion de Funciones

Eso se hace con la documentación xml que se pone dentro del código. Cuando
se compila o genera el proyecto se crea un archivo xml que contiene esta
documentación y aparece luego en el Intellisense como la de las clases de la
.NET Fx. Por ejemplo:

''' <summary>
''' Esta clase sirve para esto y aquello
''' </summary>
''' <remarks>
''' Aquí cuento los detalles. En esta sección
''' me enrollo todo lo que quiero y más
'''</remarks>
Public Class MiClase

''' <summary>
''' Este método hace esto y lo otro
''' </summary>
''' <param name="Datos">
''' Los datos que se le pasan a MiMetodo
''' </param>
''' <remarks>
''' Más detalles acerca de MiMetodo
''' </remarks>
''' <exception cref="ArgumentException">Cuando los Datos no son
validos</exception>
Public Sub MiMetodo(ByVal Datos As Object)

End Sub

''' <summary>
''' Esta propiedad significa esto y sirve para esto otro
''' </summary>
''' <value></value>
''' <returns></returns>
''' <remarks></remarks>
Public Property MiPropiedad() As Object
Get

End Get
Set(ByVal value As Object)

End Set
End Property

End Class


Saludos:

Jesús López


"Broker" escribió en el mensaje
news:

Hola Buenos dias,

Estoy haciendo una libreria de clases, y me gustaria poner en cada funcion
una pequeña descripcion de lo que hace y lo que hacen sus parametros.
Imagino
que esto se puede hacer porque en las clases que viene con el .NET cuando
estas dentro de un metodo o propiedad te dice una pequeña ayuda en un
tooltip.

Mi pregunta es, como se puede hacer eso?, he estado buscando por ahi, y no
encuentro nada, haber si me podeis ayudar.

Un Saludo y Gracias anticipadas.

Declara #Region " Lo que tu necesitas como definición "
y el Net te pondrá
#End Region

Muchas Gracias, me sirvio de ayuda. Un Saludo

"Jesús López" escribió:

Eso se hace con la documentación xml que se pone dentro del código. Cuando
se compila o genera el proyecto se crea un archivo xml que contiene esta
documentación y aparece luego en el Intellisense como la de las clases de la
..NET Fx. Por ejemplo:

''' <summary>
''' Esta clase sirve para esto y aquello
''' </summary>
''' <remarks>
''' Aquí cuento los detalles. En esta sección
''' me enrollo todo lo que quiero y más
'''</remarks>
Public Class MiClase

''' <summary>
''' Este método hace esto y lo otro
''' </summary>
''' <param name="Datos">
''' Los datos que se le pasan a MiMetodo
''' </param>
''' <remarks>
''' Más detalles acerca de MiMetodo
''' </remarks>
''' <exception cref="ArgumentException">Cuando los Datos no son
validos</exception>
Public Sub MiMetodo(ByVal Datos As Object)

End Sub

''' <summary>
''' Esta propiedad significa esto y sirve para esto otro
''' </summary>
''' <value></value>
''' <returns></returns>
''' <remarks></remarks>
Public Property MiPropiedad() As Object
Get

End Get
Set(ByVal value As Object)

End Set
End Property

End Class


Saludos:

Jesús López


"Broker" escribió en el mensaje
news:
> Hola Buenos dias,
>
> Estoy haciendo una libreria de clases, y me gustaria poner en cada funcion
> una pequeña descripcion de lo que hace y lo que hacen sus parametros.
> Imagino
> que esto se puede hacer porque en las clases que viene con el .NET cuando
> estas dentro de un metodo o propiedad te dice una pequeña ayuda en un
> tooltip.
>
> Mi pregunta es, como se puede hacer eso?, he estado buscando por ahi, y no
> encuentro nada, haber si me podeis ayudar.
>
> Un Saludo y Gracias anticipadas.