¿Qué documentos de estándares de codificación de Delphi sigues?

Question

¿Qué documentos de estándares de codificación de Delphi sigues?

Nuestra empresa 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: I do no quiero comenzar una guerra de estilo. Solo quiero saber qué normas sigues y por qué.

Gracias.

---

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

Answer 1

JCL Delphi Lenguaje de estilo

(una extensión de CodeGear de “Object Guía Pascal Estilo”)

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

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

versión

Answer 2

“Guía de Estilo Object Pascal” de CodeGear Guía

http://edn.embarcadero.com/article/10280

Answer 3

JVCL-prolongado de CodeGear de “Object Pascal Guía de Estilo”

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

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

(Gracias a Jeroen van Pluimers, para proporcionar el nuevo enlace.)

Answer 4

ECONOS - (. Subtitulado “Delphi 4 del desarrollador Guía de Normas de codificación de documentos”) que codifica Documento Estándar

http://www.econos.de/delphi/cs.html

Answer 5

“mantequilla de maní húngara” de CodeGear, para los identificadores de nombres

http://dn.codegear.com/article/27983

Answer 6

“Delphi Identifier” Convenciones de nomenclatura de About.com

http://delphi.about.com/od/standards/l/bldnc.htm

Answer 7

Realmente no importa el tiempo que tienes que elegir uno y se adhieren a ella.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.

Answer 8

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.

Acepto 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.

así, echa un vistazo a sus variantes de codificación existentes y reunir al equipo para algunas discusiones vibrantes en:

• Las razones para la adopción de un estándar de codificación.
• Consideraciones esenciales en la estandarización.
• Allanando cualquier inseguridad en el equipo que rodea este problema.
• Encontrar un punto de acuerdo. Lo que es importante y lo que no es
• Establecer 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 su empresa.

Answer 9

Por algún motivo histórico, 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.