delphi naming-conventions coding-style

¿Qué documento(s) de estándares de codificación de Delphi sigues?



naming-conventions coding-style (9)

Por alguna razón histórica inane, el estándar de codificación en mi trabajo es tener todas las palabras clave en mayúsculas, tanto en delphi como en sql. Gracias a Dios por el bloqueo de mayúsculas.

¿Qué documento (s) de estándares de codificación de Delphi sigues?

Nuestra compañía está buscando implementar mejores estándares de codificación para mejorar la legibilidad, capacidad de revisión y mantenimiento de nuestro código. Nos encontramos con la "Guía de estilo Object Pascal" de CodeGear, pero no se ha tocado en bastante tiempo y me imagino que varias personas han realizado algunas mejoras o adiciones locales. He encontrado algunas variaciones publicadas y otros documentos, que enumeraré a continuación.

NB: No quiero comenzar una guerra de estilo. Solo quiero saber qué normas sigues y por qué.

Gracias.

ACTUALIZACIÓN: ¡ Bien, la "Guía de estilo de lenguaje JCL Delphi" parece ser el claro ganador! ¡Gracias!

Puede haber una tendencia a sobre-diseñar estándares de codificación hasta el punto en que se interponen en la forma de escribir código.

Estoy de acuerdo con el comentario de Jozz. Puede mirar todos los estándares recomendados, elegir uno y forzarlo a sus codificadores o puede hacer que su equipo participe en el proceso.

En mi experiencia, la mejor manera de involucrar a un equipo es hacer que el equipo presente la idea y los beneficios de la adopción. Tu talento actual es tu mejor recurso. Del mismo modo, pueden ser tu máximo enemigo si los obligas a seguir un camino en el que no creen.

Por lo tanto, eche un vistazo a las variantes de codificación existentes y reúna al equipo para algunas discusiones vibrantes sobre:

  • Las razones para adoptar un estándar de codificación.
  • Consideraciones esenciales en la estandarización.
  • Al salir de cualquier inseguridad en el equipo que rodea este problema.
  • Encontrar un punto de acuerdo. Lo que es importante y lo que no es
  • Estableciendo algunos objetivos corporativos para que todos sientan que están trabajando hacia un objetivo común.
  • Haga que el equipo venda los beneficios de la estandarización.

El objetivo más importante debe ser establecer un "estándar" que mejor sirva a su equipo y a su empresa.

Realmente no importa siempre que elijas uno y te apegues a él. Un estándar de codificación es como un dialecto, y mientras todos en el equipo hablen el mismo dialecto, estás bien.

Dicho esto, ¿por qué no elegir el mismo estándar que su biblioteca de tiempo de ejecución (VCL) y el uso de documentación? Entonces todos estarán hablando el mismo dialecto y les será más fácil leer el código de la biblioteca en tiempo de ejecución. Y hay muchos ejemplos de código para ilustrar las convenciones de codificación.

JCL Delphi Language Style Guide

(Una extensión de la "Guía de estilo Object Pascal de CodeGear")

http://jcl.delphi-jedi.org/documents/styleguide.html

(Gracias, Jeroen Pluimers, por notar que el enlace original de borland.com había muerto y por proporcionar el nuevo enlace).

Versión extendida de JVCL de la "Guía de estilo Object Pascal de CodeGear"

(Esto se parece a la versión de JCL, para mí).

http://jvcl.delphi-jedi.org/StyleGuide.htm

(Agradecemos a Jeroen Pluimers por proporcionarnos el nuevo enlace).