se nos ha ocurrido con la siguiente convención de nomenclatura clave (Java, por cierto) usando la notación de punto y el caso de camellos:
teclas de etiquetas (títulos formar etiquetas, página/forma/de aplicaciones, etc ... es decir, no frases completas, que se utiliza en múltiples ubicaciones de interfaz de usuario):
Si la etiqueta representa un campo Java (es decir, un campo de formulario) y coincide con la etiqueta forma: label.nameOfField
Else: label.sameAsValue
Ejemplos:
- label.firstName = Nombre
- label.lastName = Apellido
- label.app licationTitle = Título de la aplicación
- label.editADocument = editar un documento
claves de contenido:.
projectName.uiPath.messageOrContentType.n *
Dónde:
- projectName es el nombre corto del proyecto (o un nombre derivado del paquete de Java)
- uiPath es la ruta de navegación de interfaz de usuario con el contenido clave
- messageOrContentType (por ejemplo, añadido, suprimido, actualizada, información, advertencia, error, título, contenido, etc.) debe ser añadido basado en el tipo de contenido. Mensajes de ejemplo: (1) La página ha sido actualizada. (2) Hubo un error al procesar su solicitud.
- n. * maneja los siguientes casos: cuando hay varias áreas de contenido en una sola página (por ejemplo, cuando el contenido está separado por una imagen, etc.), cuando el contenido está en varios párrafos o cuando el contenido está una lista ordenada (no) - se debe agregar un identificador numérico. Ejemplo: ... content.1, ... content.2
Cuando hay varias áreas de contenido de una página y una o más necesidad de ser roto más arriba (basado en el ejemplo HTML anterior), un identificador numérico secundario se puede anexar a la clave. Ejemplo: ... content.1.1, ... content.1.2
Ejemplos:
- training.mySetup.myInfo.content.1 = esta es la primera frase del contenido 1. Esta es la segunda oración del contenido 1. Este contenido estará rodeado por etiquetas de párrafo.
- training.mySetup.myInfo.content.2 = Esta es la primera oración del contenido 2. Esta es la segunda oración del contenido 2. Este contenido también estará rodeado por etiquetas de párrafo.
- training.mySetup.myInfo.title = Mi información
- training.mySetup.myInfo.updated = Su información personal ha sido actualizada.
ventajas/desventajas:
teclas
+ etiqueta puede ser fácilmente reutilizados; la ubicación es irrelevante.
+ Para las claves de contenido que no se reutilizan, la ubicación de la página en la interfaz de usuario será simple y lógica.
- Puede no ser claro para los traductores que las claves de etiqueta residen en la interfaz de usuario. Esto puede no ser un problema para los traductores que no navegan por las páginas, pero puede ser un problema para los desarrolladores.
- Si las claves de contenido se deben usar en más de una ubicación en la UI (lo cual es muy probable), la elección del nombre de la clave no tendrá sentido en la (s) otra (s) ubicación (es).En nuestro caso, la administración no se preocupa por una duplicación de valores para las áreas de contenido, por lo que usaremos diferentes claves (para demostrar la ubicación en la interfaz de usuario) en este caso.
Comentarios sobre esta convención - especialmente retroalimentación que mejorarlo - sería muy apreciada ya que estamos renovando actualmente nuestros paquetes de recursos! :)
Es esto o propiedades Java .¿RED? –
¡Buena pregunta! Lo que describió anteriormente es una excelente guía para nombrar propiedades. Lamentablemente, esta es también un área muy subjetiva. Me gustaría ver qué sugiere el resto de la comunidad. –