Incluyendo comentarios en expresiones regulares de Java

Question

Tengo algunas expresiones regulares complejas que debo comentar para la legibilidad y el mantenimiento. La especificación de Java es bastante escueta y he luchado durante mucho tiempo para que funcione. Finalmente me quedé sin error y se publicará como una respuesta pero estaría agradecido por cualquier otro consejo sobre expresiones regulares que mantienen

Como ejemplo quiero comentar los subcomponentes (de los patrones) en un nombre analizador simple:

String testTarget = "Waldorf T. Flywheel"; 
    String patternS = "([A-Za-z]+)\\s+([A-Z]\\.)?\\s+([A-Za-z]+)"; 
    Pattern pattern = Pattern.compile(patternS, Pattern.COMMENTS); 
    Assert.assertTrue(pattern.matcher(testTarget).matches()); 

EDITAR: Estaría agradecido por los ejemplos del formato (? X) también.

EDITAR: @ ​​geowa4 tiene una buena sugerencia que evita los comentarios incrustados. Sinnce Java y otros han proporcionado comentarios incrustados, ¿cuáles son los casos en que son útiles? (Creo que tengo un caso, pero me gustaría ver a otros).

EDIT: Como se señala más adelante @mikej la expresión regular no admite el pozo inicial opcional y sería mejor como:

 String patternS = "([A-Za-z]+)\\s+([A-Z]\\.\\s+)?([A-Za-z]+)"; 

pero que terminaría la extracción de espacio en la inicial

Answer 1

Ver el mensaje por Martin Fowler en ComposedRegex para más ideas sobre cómo mejorar la legibilidad de expresiones regulares. En resumen, recomienda desglosar una expresión regular compleja en partes más pequeñas a las que se les puedan dar nombres de variables significativos. p.ej.

String mandatoryName = "([A-Za-z]+)"; 
String mandatoryWhiteSpace = "\\s+"; 
String optionalInitial = "([A-Z]\\.)?"; 
String pattern = mandatoryName + mandatoryWhiteSpace + optionalInitial + 
    mandatoryWhiteSpace + mandatoryName; 

Answer 2

encontré la trabajado siguientes:

 String pattern2S = 
      "([A-Za-z]+)  # mandatory firstName\n" + 
      "\\s+    # mandatory whitespace\n " + 
      "([A-Z]\\.)?  # optional initial\n" + 
      "\\s+    # whitespace\n " + 
      "([A-Za-z]+)  # mandatory lastName\n"; 

la clave era incluir el carácter de nueva línea \ n explícitamente en la cadena

Answer 3

¿Por qué no acaba de hacer esto:

String pattern2S = 
    "([A-Za-z]+)" + // mandatory firstName 
    "\\s+" +  // mandatory whitespace 
    ...; 

CONTINUACIÓN:

Si desea mantener los comentarios con el patrón y hay que leerlo desde un archivo de propiedades, utilice la siguiente:

pattern=\ 
#comment1\\n\ 
(A-z)\ 
#comment2\\n\ 
(0-9)