Uso de comentarios del lado del servidor en ASP.NET

Todos sabemos que es una práctica común y buena Añadir comentarios a su código. Esto lo ayuda a documentar los diversos componentes de su aplicación para que usted u otra persona puedan determinar cuál es el propósito del código cuando lo revisen en el futuro.

Además, los comentarios son muy valioso al depurar y/o solucionar problemas con su aplicación que aparecen en tiempo de ejecución. Comentar un bloque de código puede ayudarte a aislar el origen de un problema. En este artículo, vamos a discutir el proceso de lo que se conoce como comentarios del lado del servidor.

Una página ASPX típica generalmente contienen una combinación de controles HTML y ASPX. La mayoría de los desarrolladores web están muy familiarizados con el uso de comentarios HTML. <!-- comments -->. Aquí hay un ejemplo de cómo usar un comentario HTML:

<!--
This is an HTML comment that will not be displayed in the browser window
-->

Si bien el comentario HTML se puede usar dentro de la página ASPX, hay una ventaja al usar comentarios del lado del servidor, de la que hablaremos a continuación. Para crear un comentario del lado del servidor para documentación o solución de problemas, rodee su contenido HTML y ASPX con estos caracteres especiales: <%-- comments --%>. Aquí hay un ejemplo de cómo incorporar comentarios del lado del servidor en sus páginas ASPX:

<%--
This block of HTML/ASPX markup will not be parsed by ASP.NET.
       
    <asp:label ID="label1" runat="server"></asp:label>
    <%# Eval("SomeProperty")%>

--%>

Tanto los comentarios HTML como ASPX producen un resultado similar al no estar mostrando los comentarios en la ventana del navegador. sin embargo, el diferencia principal entre ellos y la ventaja del comentario del lado del servidor es que, dado que el motor ASP.NET no analiza el comentario del lado del servidor, se eliminará y no devuelto al navegador como un comentario HTML.

Esto reduce el tamaño de la página y por lo tanto no agrega datos adicionales que deben ser descargados por el navegador. Si tuviera que ver el código fuente de la página web (normalmente haciendo clic con el botón derecho en una página web y seleccionando ‘Ver fuente’), no vería los comentarios del lado del servidor que incluido en su página ASPX.

Ejemplo

Tomemos el siguiente ejemplo en un página ASPX y verlo usando un navegador web en tiempo de ejecución. El ejemplo incluirá un comentario HTML, así como un comentario del lado del servidor.

Cuando acceda a esta página a través de un navegador, verá que el comentarios del lado del servidor no fueron incluidos por el motor ASP.NET cuando se generó el marcado HTML. Puede ver esto haciendo clic derecho en la página web dentro de la ventana del navegador y seleccionando Ver código fuente.

Resumen

En este tutorial, vimos cómo puede usar los comentarios del lado del servidor en su ASP.NET .ASPX archivos Si bien ambos producen el mismo resultado con respecto a la documentación dentro de su marcado y no mostrar en la ventana del navegador, notamos cómo los comentarios del lado del servidor son remoto durante el proceso de compilación del código ASP.NET en marcado HTML por el motor ASP.NET.