Automatizar los comentarios de código en AX

Esto creo que va a ser útil para la gente con experiencia en otros lenguajes de programación y que empieza a programar en X++, sobre todo en entornos en lo que hay otras personas programando y si no se utiliza un programa de control de versiones se hace obligado introducir comentarios para diferenciar las partes de código que se modifican.

Para ello se tiene que retocar una clase estándar EditorScripts, que esta clase te permite además de introducir comentarios de forma automática, añadir templates o plantillas, enviar el contenido del editor por correo, a un fichero o a la impresora, convertir un texto en mayúsculas o en minúsculas según lo selecciones.

Para automatizar los comentarios en función del desarrollo, vamos a crear una tabla donde indiquemos el usuario, código de desarrollo, descripción del desarrollo, y desarrollo activo para indicar el desarrollo en el que se esta desarrollando. Esta tabla la llamaremos AX3ActiveTask, crearemos el índice por usuario y tarea activa.

Esta tabla la usaremos para las plantillas de los comentario, y para hacer uso de esta, vamos a crear 5 métodos en la clase EditorScripts para introducir comentarios pudiendo ser inicio y fin de comentario, inicio o fin.

Un ejemplo de uno de estos métodos nuevos que usan nuestra nueva tabla sería:

//CREATED BY: IB_Admin /· - ·/
void Ax3_CommentBlock(Editor e)
{
int startLine = e.selectionStartLine();
int endLine = e.selectionEndLine();
int i;
str User = curUserId();
;
e.unmark();
e.gotoLine(startline);
e.gotoCol(1);
e.insertLines("\n");
e.insertLines('//START BLOCK ' + 'BY: AX3_' + User+ ' ON:' + date2str(today(),123,2,4,2,4,2 ) + Ax3ActiveTask::aoDescription() +' \n');
e.gotoLine(endLine+3);
e.insertLines('//END BLOCK ' + 'BY: AX3_' + User+ ' ON:' + date2str(today(),123,2,4,2,4,2 ) + Ax3ActiveTask::aoDescription() +' \n');

}

Una vez creado estos métodos, para usarse dentro de una sentencia dentro de código que se quiera comentar es tan sencillo cómo esto:

1º Se define en la tabla creada el código de desarrollo y descripción y se activa.

2º Se usa ese comentario en la porción de código que se desee marcar con ese comentario:

Espero que la utilización de esta automatización por lo menos ayude a marcar mejor el código para poder seguir las modificaciones que se produzcan si no se usa el control de versiones.

Crosposting from http://www.ax3.es/blog