El Bruno

Blog dedicado a las experiencias del desarrollo con tecnologías Microsoft.
[VS] Un par de CodeSnippets -> to validate, to validate, to validate

Buenas,

un par de snippets para ir cerrando la semana en un lunes que pinta fatal. Por un lado, las clásicas líneas para validar si un argumento es nulo y además otro codesnippet para validar si un argumento de tipo String es válido. Ambos code snippets se pueden descargar desde aquí o se pueden crear con el código fuente incluido al final de este post.

 

Instalación

Una vez descargados el proceso para importar los mismos es el siguiente:

1. Seleccionar Menu Tools // Code Snippets Manager

 

2. Seleccionar C# como lenguaje y hacer click en el boton Import

 

3. Seleccionar los archivos que se han descargado chkparNull.snippet y chkparString.snippet; y a continuación seleccionar la ubicación Visual C# para importar los Code Snippets

 

4. Una vez importados, podremos ver en la aplicación dentro del listado de Code Snippets los nuevos Code Snippets que hemos importado.

 

Ejemplo

Una vez instalados, podremos utilizar los mismos directamente desde nuestro editor de codigo, simplemente desplegando el menu contextual y seleccionando la opción Insert Snippet. Seleccionamos uno de los snippets importados desde la lista y podremos ver que en el caso del snippet para validar argumentos nos sugiere completar el nombre del parámetro a validar:

 

Una vez completado el valor del campo Param_Name, nuestro código queraría como el siguiente ejemplo:

public void DemoFunction(string stringParameter, object objectParameter) { if (objectParameter == null) throw new ArgumentNullException("objectParameter", "the param objectParameter is null"); }

El funcionamiento del snippet para validar parámetros del tipo string es similar.

 

Código Fuente

Check Null Parameter

<?xml version="1.0" encoding="utf-8" ?> <CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet"> <CodeSnippet Format="1.0.0"> <Header> <Title>Check Param Null</Title> <Shortcut>chkparNull</Shortcut> <Description>Code snippet for adding the necessary code to check a null parameter.</Description> <Author>Bruno Capuano</Author> <SnippetTypes> <SnippetType>Expansion</SnippetType> </SnippetTypes> </Header> <Snippet> <Declarations> <Literal> <ID>fldParam</ID> <ToolTip>Parameter Name</ToolTip> <Default>Param_Name</Default> </Literal> </Declarations> <Code Language="csharp"> <![CDATA[if ($fldParam$ == null) throw new ArgumentNullException("$fldParam$", "the param $fldParam$ is null");]]> </Code> </Snippet> </CodeSnippet> </CodeSnippets>

 

Check String Parameter

<?xml version="1.0" encoding="utf-8" ?> <CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet"> <CodeSnippet Format="1.0.0"> <Header> <Title>Check Param String</Title> <Shortcut>chkparString</Shortcut> <Description>Code snippet for adding the necessary code to check a string parameter.</Description> <Author>Bruno Capuano</Author> <SnippetTypes> <SnippetType>Expansion</SnippetType> </SnippetTypes> </Header> <Snippet> <Declarations> <Literal> <ID>fldParam</ID> <ToolTip>Parameter Name</ToolTip> <Default>Param_Name</Default> </Literal> </Declarations> <Code Language="csharp"> <![CDATA[if (string.IsNullOrEmpty($fldParam$)) throw new ArgumentNullException("$fldParam$", "the param $fldParam$ is invalid");]]> </Code> </Snippet> </CodeSnippet> </CodeSnippets>

 

Saludos @ Marron

El Bruno

 

Share this post :

Published lunes, 28 de abril de 2008 17:39 by elbruno

Filed under: ,

Comments

No Comments