Encabezado de código habilitado para VSS
Desde luego que sé como muchos desarrolladores se sienten con respecto a VSS, pero he venido usando este pequeño truco (por falta de una mejor palabra) por varios años y pensé que ya era tiempo de compartirlo por si le es de beneficio a alguien más. En cada programa utilizo una región como la siguiente:
#region Version Header
/// <remarks>
/// $Workfile: MiLogger.cs $
/// Descripción: Esta clase implementa un archivo de registros (log) usando la librería ABC.
/// Autor: José Luis Manners Docs: José Luis Manners
/// Creado: 07/30/2004 13:23:35pm
/// $Modtime: 08/21/2004 09:35:23am $
/// $Revision: 3 $
/// Derechos: © 2004 Nombre de la empresa va aquí
/// </remarks>
#endregion
Basicamente esto es un encabezado que pongo en cada archivo de C#. No hay peor situación que tratar de modificar código escrito por otra persona (o tal vez escrito por uno mismo) sin siquiera saber (o recordar) cual es el objetivo del mismo o como su propósito ha cambiado con el tiempo. Lo que hace interesante este encabezado es que aprovecha las cualidades de expansión de palabras claves que tiene VSS, de tal manera que datos como el nombre del fichero, fecha de última modificación, versión, etc., son actualizados de forma automática por VSS cada vez que el archivo sea protegido (checked-in). Por cierto, las palabras claves de VSS son aquellas rodeadas con el símbolo de dinero ('$').
Para hacer el trabajo más fácil y evitar copiar y pegar cada vez que se crea un fichero nuevo, usted puede crear una plantilla que ya tenga este encabezado incluído y asi cuando usted genere una nueva clase el encabezado será incluído junto con el código generado por VS.NET (puede encontrar muchos recursos en línea sobre como crear plantillas de código en VS.NET). Yo en mi caso en particular tengo un macro que se ejecuta cada vez que creo una nueva clase. El macro muestra una caja de diálogo donde entro la descripción y este luego se encarga de llenar el resto de la información del encabezado, incluyendo poner la fecha del sistema en la sección titulada "Creado" y por supuesto genera el encabezado.
Hay una palabra clave de VSS que omití y esta es "$History: $". Con esta palabra clave usted puede mantener un registro de todos los cambios que se han hecho en un programa de manera tal que información como la versión, comentarios, nombre de la persona que hizo el cambio, fechas, etc., son puestos directamente en el código. Esta es básicamente la información que se puede ver desde VSS cuando se selecciona un archivo y se escoje la opción "Show History" y luego se escoje "History Details". Aunque tener toda esta información histórica almacenada en el código puede resultar abrumadora y redundante también puede ser muy beneficiosa. Tome en cuenta estos factores a la hora de decidir.
CONSEJO: Si le es necesario mantener el historial en su código lo puede poner en una región por separado de esa manera está fuera de la vista y solamente lo abre cuando sea necesario.
Para más información sobre las funciones de expansión de palabras claves de VSS y para obtener una lista más completa vea el siguiente enlace:
Visual SourceSafe: Compatibilidad con expansión de palabras clave