Embarcadero acaba de publicar en el sitio docwiki una versión actualizada de la guía de estilo de idiomas. El documento se ha actualizado para cubrir las características modernas del lenguaje Delphi y algunos cambios en el estilo de codificación.
Durante los últimos meses, realicé un esfuerzo para publicar una nueva guía de estilo de Object Pascal para el lenguaje Delphi actual. Del prefacio:
“Este documento es una versión actualizada de la guía de estilo clásica de Object Pascal, originalmente seleccionada por Charlie Calvert para Borland en el momento en que se lanzó originalmente Delphi. La versión actualizada ha sido seleccionada por el gerente de productos de Delphi, Marco Cantu, con contribuciones del equipo interno de I + D, los MVP de Delphi y la comunidad de Delphi en general “.
El texto no es una guía de idioma, sino que cubre el uso de espacios en blanco y el formato al escribir código, algo que el compilador generalmente ignora. Nada es obligatorio aquí, esto es solo una recomendación para favorecer la legibilidad. Seguir estas reglas es un requisito para nuestro propio equipo interno y cualquier colaborador.
Puede encontrar la guía de estilo en http://docwiki.embarcadero.com/RADStudio/Sydney/en/Delphi’s_Object_Pascal_Style_Guide .
Este es el índice del documento:
- Introducción
- Reglas generales: identificadores, palabras clave, sangría
- Archivos de código fuente, unidades y su estructura
- Uso de espacios en blanco
- Comentarios
- Declaraciones
- Declaraciones de tipo
Terminaré este blog publicando la breve introducción:
Si bien los compiladores de Delphi generalmente ignoran cualquier espacio en blanco y permiten mucha flexibilidad en la forma en que un desarrollador escribe el código, para la legibilidad y el mantenimiento del código fuente, Embarcadero ha definido un conjunto de pautas utilizadas por la I + D interna y cualquier desarrollador involucrado con el código fuente. proyecto. Recomendamos a la comunidad de Delphi en general que adopte este estilo de codificación y formato.
La introducción de la versión original de este documento lo expresa muy bien:
“Object Pascal es un lenguaje bellamente diseñado. Una de sus grandes virtudes es su legibilidad. Estos estándares están diseñados para mejorar la legibilidad del código Object Pascal. Cuando los desarrolladores sigan las convenciones simples establecidas en esta guía, promoverán estándares que beneficien a todos los desarrolladores de Delphi al usar un estilo uniforme que es fácil de leer. Los esfuerzos para hacer cumplir estos estándares aumentarán el valor del código fuente de un desarrollador, particularmente durante los ciclos de mantenimiento y depuración “.
Este documento no hace referencia ni explica la sintaxis y la gramática del lenguaje, ya que solo se centra en definir el estilo de escritura de código en lugares donde el idioma le da una opción, al permitir muchas opciones diferentes en términos de espacios en blanco y formato.
Ninguna de estas pautas está escrita en piedra y esperamos que evolucionen con el tiempo junto con el idioma.