Capítulo 74. Cuida las declaraciones de tus módulos
Este trabajo se ha traducido utilizando IA. Agradecemos tus opiniones y comentarios: translation-feedback@oreilly.com
Nicolai Parlog
Si estás creando módulos Java, tus declaraciones de módulo( archivosmodule-info.java ) son fácilmente tus archivos fuente más importantes. Cada uno de ellos representa un JAR entero y rige su interacción con otros JAR, así que ¡cuida bien tus declaraciones! He aquí algunas cosas que debes tener en cuenta.
Mantén limpias las declaraciones de los módulos
Las declaraciones de módulos son código y deben tratarse como tal, así que asegúrate de que se aplica tu estilo de código. Más allá de eso, en lugar de colocar directivas al azar, estructura tus declaraciones de módulos. Éste es el orden que utiliza el JDK:
-
Requiere, incluyendo estática y transitiva
-
Exportaciones
-
Exportaciones a
-
Abre
-
Abierto a
-
Utiliza
-
Proporciona
Decidas lo que decidas, si tienes un documento que defina tu estilo de código, registra allí la decisión. Si tu IDE, herramienta de compilación o analizador de código comprueba estas cosas por ti, aún mejor. Intenta ponerlo al día para que pueda comprobar automáticamente -o incluso aplicar- el estilo que hayas elegido.
Declaraciones del módulo de comentarios
Las opiniones sobre la documentación del código , como Javadoc o los comentarios en línea, varían mucho, pero sea ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access