Microsoft y otros desarrolladores de software recomienda comentar el código. Documentación de código le ayuda a entender el software que usted cree. También ayuda a los programadores que pueden mantener su aplicación en el futuro. El programa de Microsoft Visual Studio simplifica el proceso de documentación de software. Basta con añadir el texto XML en el código , y el software integrar sus comentarios dentro de la aplicación . Después de compilar el proyecto , cualquiera puede ver sus comentarios en una página Web. Instrucciones
Crear Proyecto
1
Abra Visual Studio. Seleccione " Archivo" y "Nuevo proyecto " para abrir el "Nuevo Proyecto " ventana .
2 Haga clic en " Visual C #" para resaltarlo y haga doble clic en "Aplicación Web ASP.NET. " < Br >
3
Type " MiSitioWeb " en el cuadro de texto "Nombre" y haga clic en " Aceptar". Visual Studio creará un nuevo proyecto llamado " MiSitioWeb " y mostrar sus archivos de proyecto en el panel Explorador de soluciones. Usted verá un archivo llamado " Default.aspx " en el Explorador de soluciones. Esta es la página principal del sitio web.
4
clic en la flecha junto al doble clic en " Default.aspx " y " Default.aspx.cs . " Este archivo contiene C código de la página #.
5
" Default.aspx.cs ". Haga doble clic en Visual Studio mostrará su código en la ventana de código . Usted verá un método llamado " Load " que tiene este aspecto :
protected void Page_Load ( object sender, EventArgs e) {
}
Este método se ejecuta cuando el navegador carga la página
6
Añada la siguiente línea de código entre los dos caracteres de corchete :
int carPrice = computePrice ();
< p . > Esto llama a otro método denominado computePrice . Después de agregar código, el método se verá así :
protected void Page_Load ( object sender, EventArgs e) {
int carPrice = computePrice ();
}
7
Agregue el método siguiente después del último carácter de corchete del método anterior :
computePrice private int () { int
basePrice = 20000 ;
int impuestos = 1,800 ;
int totalprice = + impuestos basePrice ;
totalprice return; }
Este método calcula un total precio con un precio de base y un impuesto sobre las ventas . El método no hay comentarios en este momento .
8
Coloque el cursor del ratón sobre "int computerPrice privada () {" y escriba " ///" (sin las comillas). Pulse el botón " Enter". Visual Studio convertirá los tres caracteres de barra en el siguiente bloque de texto :
///
///foto
///< /summary>
/// < /returns >
texto que se introduce dentro de este bloque aparecerá en comentarios XML de la página web. Este bloque de código tiene un lugar para poner un resumen del método y el tipo de valor que devuelve el método
9
Modificar el bloque de código para que se vea así: .
///foto ///Este método calcula el precio total con un precio de base y un impuesto sobre las ventas .
///< /summary>
< p > /// el método devuelve el precio total al método de llamada . < /returns >
la sección "Resumen ", ahora se describe el método y la sección de " retornos ", describe el tipo de variable que devuelve el método .
ver comentario Página Web
10
Localizar el proyecto " MiSitioWeb " en el Explorador de soluciones "y haga clic derecho . Seleccione" Propiedades "para abrir la ventana de " Propiedades" del proyecto.
11
clic en la pestaña " Build " y poner una marca de verificación al lado de " archivo de documentación XML. "
12
Haga clic en " Navegar . " Explorador de Windows se abrirá y mostrará el proyecto " Ruta de salida . " Esta es la ubicación donde Visual Studio almacenará el proyecto compilado .
13
Localice la barra de direcciones en la parte superior del Explorador de Windows . Usted verá una ruta de carpeta por lo general, este aspecto: .
myUserAccount \\ Documents \\ Visual Studio 2010 \\ Project \\ miSitioWeb \\ mywebsite \\ bin
La ruta real puede ser diferente en su equipo < . br> 14
Haga clic en un área vacía de la barra de direcciones y seleccione " Copiar dirección ". Windows copiará la ruta al portapapeles. Haga clic en " Cancelar " para cerrar el Explorador de Windows .
15
Vaya al Explorador de soluciones y haga clic en " MiSitioWeb . " Select "Build ". Visual Studio compilará el proyecto y crear un archivo XML que contiene sus comentarios.
16
Haga clic en Windows " Inicio" del menú y haga clic en el cuadro "Buscar" en la parte inferior del menú Inicio . Seleccione " pegar". Windows le pegue la ruta que copió en el cuadro " Buscar".
17 < p> Presione " Enter". Explorador de Windows se abrirá y mostrará el contenido de la carpeta que contiene el proyecto compilado .
18
Localizar " My_Website.XML " y haga clic derecho en el archivo . Seleccione "Open Con " y seleccione " Internet Explorer. "Internet Explorer se abrirá y mostrará una página web que muestra sus comentarios .
