No dudes en compartir nuestro sitio y códigos con otro, danos de tu ayuda para ampliar nuestra comunidad.
Solución:
Para generar un área donde pueda especificar una descripción para la función y cada parámetro para la función, escriba lo siguiente en la línea antes de su función y presione Ingresar:
-
C#:
/// -
VB:
'''
Consulte Etiquetas recomendadas para comentarios de documentación (Guía de programación de C #) para obtener más información sobre el contenido estructurado que puede incluir en estos comentarios.
Lo que necesitas es comentarios xml – Básicamente, siguen esta sintaxis (como la describe vagamente Solmead):
C#
///
///This is a description of my function.
///
string myFunction()
return "blah";
VB
'''
'''This is a description of my function.
'''
Function myFunction() As String
Return "blah"
End Function
losC> le ofrece una forma de indicar que el texto dentro de una descripción debe marcarse como código. Usarcódigo> para indicar varias líneas como código.
content
loscódigo> etiqueta le ofrece una forma de indicar varias líneas como código. UsarC> para indicar que el texto dentro de una descripción debe marcarse como código.
losejemplo> le permite especificar un ejemplo de cómo utilizar un método u otro miembro de la biblioteca. Esto comúnmente implica el uso decódigo> etiqueta.
losexcepción> le permite especificar qué excepciones se pueden lanzar. Esta etiqueta se puede aplicar a definiciones de métodos, propiedades, eventos e indexadores.
losincluir> etiqueta le permite hacer referencia a comentarios en otro archivo que describen los tipos y miembros en su código fuente. Esta es una alternativa a colocar comentarios de documentación directamente en su archivo de código fuente. Al colocar la documentación en un archivo separado, puede aplicar el control de fuente a la documentación por separado del código fuente. Una persona puede hacer que se extraiga el archivo de código fuente y otra persona puede hacer que se extraiga el archivo de documentación. losincluir> utiliza la sintaxis XML XPath. Consulte la documentación de XPath para conocer las formas de personalizar suincluir> utilizar.
term
description
-
term
description
losencabezado de lista> bloque se utiliza para definir la fila de encabezado de una tabla o lista de definiciones. Al definir una tabla, solo necesita proporcionar una entrada para el término en el encabezado. Cada elemento de la lista se especifica con unartículo> bloque. Al crear una lista de definiciones, deberá especificar tanto el término como la descripción. Sin embargo, para una tabla, lista con viñetas o lista numerada, solo necesita proporcionar una entrada para la descripción. Una lista o tabla puede tener tantosartículo> bloques según sea necesario.
losparaca> etiqueta es para usar dentro de una etiqueta, comoresumen>,comentarios>, odevoluciones> y le permite agregar estructura al texto.
description
losparam> La etiqueta debe usarse en el comentario de una declaración de método para describir uno de los parámetros del método. Para documentar varios parámetros, utilice variosparam> etiquetas.
El texto de laparam> se mostrará en IntelliSense, el Explorador de objetos y en el Informe web de comentarios de código.
losparamref> le da una forma de indicar que una palabra en el código comenta, por ejemplo en unresumen> ocomentarios> bloque se refiere a un parámetro. El archivo XML se puede procesar para formatear esta palabra de alguna manera distinta, como con una fuente en negrita o cursiva.
<permission cref=”member”>description
lospermiso> etiqueta le permite documentar el acceso de un miembro. La clase PermissionSet le permite especificar el acceso a un miembro.
loscomentarios> etiqueta se utiliza para agregar información sobre un tipo, complementando la información especificada conresumen>. Esta información se muestra en el Explorador de objetos.
losdevoluciones> La etiqueta debe usarse en el comentario para una declaración de método para describir el valor de retorno.
losver> etiqueta le permite especificar un enlace desde dentro del texto. Usarver también> para indicar que el texto debe colocarse en una sección Ver también. Utilice el atributo cref para crear hipervínculos internos a páginas de documentación para elementos de código.
losver también> le permite especificar el texto que podría querer que aparezca en una sección Ver también. Usarver> para especificar un enlace desde dentro del texto.
losresumen> etiqueta debe usarse para describir un tipo o un miembro de tipo. Usarcomentarios> para agregar información complementaria a la descripción de un tipo. Utilice el atributo cref para habilitar herramientas de documentación como Sandcastle para crear hipervínculos internos a páginas de documentación para elementos de código. El texto de laresumen> es la única fuente de información sobre el tipo en IntelliSense y también se muestra en el Explorador de objetos.
lostypeparam> la etiqueta debe usarse en el comentario para un tipo genérico o una declaración de método para describir un parámetro de tipo. Agregue una etiqueta para cada parámetro de tipo del tipo o método genérico. El texto de latypeparam> se mostrará en IntelliSense, el informe web de comentarios de código del Explorador de objetos.
Utilice esta etiqueta para permitir a los consumidores del archivo de documentación formatear la palabra de alguna manera distinta, por ejemplo, en cursiva.
losvalor> etiqueta le permite describir el valor que representa una propiedad. Tenga en cuenta que cuando agrega una propiedad a través del asistente de código en el entorno de desarrollo de Visual Studio .NET, agregará unaresumen> etiqueta para la nueva propiedad. A continuación, debe agregar manualmente unvalor> etiqueta para describir el valor que representa la propiedad.
Sección de Reseñas y Valoraciones
Más adelante puedes encontrar las críticas de otros administradores, tú de igual manera tienes la opción de mostrar el tuyo si lo deseas.