Autodocumentacion

Miguel Vázquez wrote:

Hola a todos.
¿Se puede autodocumentar código en VB .Net? Quiero decir,
crear leyendas en los parametros de los métodos para
indicar que significa cada uno, cuando el programador
quiera hacer uso de ellos.

Las versiones actuales no soportan la creacion de la documentacion XML como
la de C#. Sin embargo el siguiente add-in le da soporte para los comentarios
y la creacion de la documentacion. Las proxima version lo hara de forma
nativa.

VBCommenter
http://www.gotdotnet.com/workspaces...ce.aspx?id2b5449-f702-46e2-87fa-86bdf39a17dd

Eduardo A. Morcillo [MS MVP VB]
http://www.mvps.org/emorcillo

Independientemente de lo que cuenta Eduardo, que es cierto que es así,
existe la posibilidad de documentar en código porciones de este, mediante la
intrucción:

#Region "Texto"
'Código
#End Region

De esa manera, se podrá acceder en forma de árbol al código, y se podrá
consultar mediante comentarios u otras etiquetas Region dentro, de que va un
método, propiedades, etc, que ayuden al programador en el mantenimiento del
código y aplicación.

Un saludo,

Jorge Serrano Pérez
MVP Microsoft VB
PortalVB.com
http://www.portalvb.com/
Weblog de Jorge Serrano
http://weblogs.golemproject.com/jorge/
No te olvides de:
http://www.microsoft.com/spanish/ms...des/vbnet/


"Eduardo A. Morcillo [MS MVP VB]" <emorcilloATmvps.org> escribió en el
mensaje news:

Miguel Vázquez wrote:
> Hola a todos.
> ¿Se puede autodocumentar código en VB .Net? Quiero decir,
> crear leyendas en los parametros de los métodos para
> indicar que significa cada uno, cuando el programador
> quiera hacer uso de ellos.

Las versiones actuales no soportan la creacion de la documentacion XML

como

la de C#. Sin embargo el siguiente add-in le da soporte para los

comentarios

y la creacion de la documentacion. Las proxima version lo hara de forma
nativa.

VBCommenter

http://www.gotdotnet.com/workspaces...ce.aspx?id2b5449-f702-46e2-87fa-86bdf39a17dd

Eduardo A. Morcillo [MS MVP VB]
http://www.mvps.org/emorcillo

Las regiones son una buena opcion para mostrar nuestro codigo ordenado, asi
cuando un desarrollador quiera ir a algo especifico de acuerdo al arbol de
regiones que hayas especificado en tu manual de estandares de programacion
podras acceder a ella, para la documentacion en VB .NET por ahora solo
existe la que se hace usando apostrofes ('), y podrias hacerlo en cualquier
lugar de tu aplicacion, el poner mas o menos comentarios no influye enel
rendimiento de tu aplicacion ya que el compilador no toma en cuenta esas
lineas. Ahora si quisieras tener una documentacion que te genere despues
reportes o alguna presentacion web, no es posible directamente en esta
version, tendrias que usar algunas herramientas que son add-ins para VB.NET,
en c# si existe eso, pero bueno en la version que se viene de .net si estara
implementado esa nueva funcionalidad, para definir tus parametros entre
otros, la manera de hacerlo seria escribiendo 3 veces apostrofe (''') y
dando enter,

Saludos
Ivan Mostacero
MCSD .NET, Perú
http://www.timpsoft.tk/
"Jorge Serrano [MVP VB]"
wrote in
message news:

Independientemente de lo que cuenta Eduardo, que es cierto que es así,
existe la posibilidad de documentar en código porciones de este, mediante

la

intrucción:

#Region "Texto"
'Código
#End Region

De esa manera, se podrá acceder en forma de árbol al código, y se podrá
consultar mediante comentarios u otras etiquetas Region dentro, de que va

un

método, propiedades, etc, que ayuden al programador en el mantenimiento

del

código y aplicación.

Un saludo,

Jorge Serrano Pérez
MVP Microsoft VB
PortalVB.com
http://www.portalvb.com/
Weblog de Jorge Serrano
http://weblogs.golemproject.com/jorge/
No te olvides de:
http://www.microsoft.com/spanish/ms...des/vbnet/


"Eduardo A. Morcillo [MS MVP VB]" <emorcilloATmvps.org> escribió en el
mensaje news:
> Miguel Vázquez wrote:
> > Hola a todos.
> > ¿Se puede autodocumentar código en VB .Net? Quiero decir,
> > crear leyendas en los parametros de los métodos para
> > indicar que significa cada uno, cuando el programador
> > quiera hacer uso de ellos.
>
> Las versiones actuales no soportan la creacion de la documentacion XML
como
> la de C#. Sin embargo el siguiente add-in le da soporte para los
comentarios
> y la creacion de la documentacion. Las proxima version lo hara de forma
> nativa.
>
> VBCommenter
>

http://www.gotdotnet.com/workspaces...ce.aspx?id2b5449-f702-46e2-87f
a-86bdf39a17dd

>
> Eduardo A. Morcillo [MS MVP VB]
> http://www.mvps.org/emorcillo
>
>

Hola :
También puedes generar paginas web donde se catalogan de forma algo
primitiva, pero rápida de localizar tus clases, métodos, funciones y
componentes :
Herramientas -> Generar pagina web de comentarios.

Un saludo.

Fco. Javier Bedoya
Web : http://javierbedoya.iespana.es
Para responder mis mensajes en las UseNet, quite ANTI SPAM
de la dirección de correo.
"Eduardo A. Morcillo [MS MVP VB]" <emorcilloATmvps.org> escribió en el
mensaje news:

Miguel Vázquez wrote:
> Hola a todos.
> ¿Se puede autodocumentar código en VB .Net? Quiero decir,
> crear leyendas en los parametros de los métodos para
> indicar que significa cada uno, cuando el programador
> quiera hacer uso de ellos.

Las versiones actuales no soportan la creacion de la documentacion XML

como

la de C#. Sin embargo el siguiente add-in le da soporte para los

comentarios

y la creacion de la documentacion. Las proxima version lo hara de forma
nativa.

VBCommenter

http://www.gotdotnet.com/workspaces...ce.aspx?id2b5449-f702-46e2-87f
a-86bdf39a17dd

Eduardo A. Morcillo [MS MVP VB]
http://www.mvps.org/emorcillo

Muchas gracias a todos por su participación.
Aun cuando las regiones ayudan a tener una mejor estructura
en nuestro código, mi pregunta iba más enfocada a tratar de
documentar los parametros de los métodos, para que el
programador tenga una mejor idea de que es lo que significa
cada uno.
¿En que versión dicen que se va a incluir de manera nativa?

Saludos!

Hola a todos.
¿Se puede autodocumentar código en VB .Net? Quiero decir,
crear leyendas en los parametros de los métodos para
indicar que significa cada uno, cuando el programador
quiera hacer uso de ellos.

¿Que otro tipo de autodocumentación tiene VB .Net?

Gracias de antemano
.