Generación de un proyecto de plug-in para una regla personalizada escrita por usuario

Para generar un proyecto de plug-in para una regla personalizada escrita por el usuario, utilice la página Plantilla de regla COBOL del asistente Proyecto de plug-in nuevo.

Generación del proyecto

Procedimiento

  1. Abra la perspectiva Desarrollo de plug-ins.
  2. En el menú principal del entorno de trabajo, pulse Archivo > Nuevo > Proyecto > Desarrollo de plug-ins > Proyecto de plug-in y pulse Siguiente. Se abre el asistente Proyecto de plug-in nuevo.
  3. En el campo Nombre de proyecto de la página Proyecto de plug-in especifique un nombre para el proyecto nuevo y pulse Siguiente.
  4. En el campo ID de la página Contenido, especifique un ID para el proyecto y pulse Siguiente.
  5. En la página Plantillas, seleccione Crear un plug-in mediante una de las plantillas, a continuación seleccione Regla de revisión de código COBOL personalizada y pulse Siguiente.
  6. En la página Plantilla de regla COBOL complete los campos siguientes:
    Clase de regla
    Especifique un nombre de clase Java totalmente calificado. El asistente asigna este nombre a la clase que se crea para implementar la regla nueva. El valor predeterminado para este campo es el ID de proyecto seguido por la serie de caracteres CobolRule.
    Consejo: El ID de proyecto es la serie de caracteres especificada en el campo ID de la página Contenido del asistente.
    Etiqueta de regla
    Especifique un nombre para la regla nueva. Este nombre se añade a la lista de reglas disponibles visualizadas en el editor de configuraciones de análisis. El valor predeterminado para este campo es "Mi regla de COBOL personalizada".
    Nota: Este nombre es traducible. Para obtener información sobre la internacionalización de series en un plug-in, consulte Internacionalización de una etiqueta de reglas o un nombre de categoría.
    Categoría
    Puede crear una categoría de regla para la regla nueva o puede añadir una regla nueva a una categoría de regla incorporada o personalizada existente.
    • Para colocar la regla nueva en una categoría de regla, pulse Crear una categoría nueva y especifique un ID de categoría y un nombre de categoría para la categoría nueva.
    • Para añadir la regla a una categoría existente, pulse Seleccionar una categoría existente, a continuación expanda la lista y seleccione la categoría a la que desea añadir la regla nueva.
    ID de categoría
    Especifique un ID de Eclipse válido para la categoría dentro de la que se visualiza la regla personalizada escrita por el usuario en el editor de configuraciones de análisis. El valor predeterminado es el ID de proyecto seguido por la palabra custom.
    Consejo: El ID de proyecto es la serie de caracteres especificada en el campo ID de la página Contenido del asistente.
    Nombre de categoría
    Especifique un nombre para la categoría dentro de la que se visualiza la regla personalizada escrita por el usuario en el editor de configuraciones de análisis. El valor predeterminado es Personalizado.
    Nota: Este nombre es traducible. Para obtener información sobre la internacionalización de series en un plug-in, consulte Internacionalización de una etiqueta de reglas o un nombre de categoría.
  7. Expanda el árbol Programa y seleccione el elemento o los elementos de lenguaje COBOL que el código de implementación de la nueva regla debe comprobar en busca de violaciones. De forma predeterminada no hay elementos seleccionados. Para obtener un ejemplo del código Java generado para los elementos seleccionados, consulte Archivos generados: código de implementación.
  8. Pulse Finalizar. El asistente crea un proyecto de plug-in para la regla personalizada escrita por usuario nueva, añade el proyecto a la vista Explorador de paquetes y abre el archivo de manifiesto en el editor de manifiestos de plug-in.
  9. Si no ha abierto todavía la perspectiva Desarrollo de plug-ins, ábrala cuando se le solicite.
  10. Cierre el editor de manifiestos de plug-in.

Resultados

El asistente Plantilla de regla COBOL añade ampliaciones de regla y categoría al archivo plugin.xml que se genera para el proyecto de plug-in de regla personalizada. Para obtener más información sobre estas extensiones, consulte Archivos generados: ampliaciones de regla y categoría.

El asistente también genera una clase Java para implementar una regla personalizada escrita por usuario. Para obtener más información sobre esta clase, consulte Archivos generados: código de implementación.

Internacionalización de una etiqueta de reglas o un nombre de categoría

Acerca de esta tarea

Si el plug-in debe poder traducirse a varios idiomas, puede internacionalizar las series traducibles. El método para internacionalizar una serie como por ejemplo una etiqueta de regla o un nombre de categoría se describe en Internationalize plug-in manifest. El procedimiento siguiente describe los pasos principales.

Procedimiento

  1. En la extensión de regla creada en plugin.xml, utilice una %variable en lugar de una serie de caracteres. Por ejemplo, para la etiqueta de regla, puede sustituir la variable %myRuleLabel:
    <analysisRule
          category="id_de_categoría"
          class="clase_de_regla"
          id="clase_de_regla"
          label="%myRuleLabel"
          severity="1">
    </analysisRule>
  2. Defina la variable en el archivo plugin.properties. Por ejemplo:%myRuleLabel="Mi etiqueta de regla".
  3. Compile el proyecto de la forma habitual.

Comentarios