Recientemente, he estado cambiando entre varios proyectos y entornos de desarrollo. Las expectativas para el estilo de codificación en cada uno son diferentes.
Ahora, mi pregunta es de tres partes, la primera, solo por curiosidad:
Respuestas:
№1. # ¿Cómo definiste y encontraste tu estilo de codificación?
A través de ejemplos de código primero en libros, luego en textos y artículos de MSDN, luego en blogs y otros sitios web.
№2. ¿Cómo sigues aumentando y mejorando?
Mantengo mi ojo abierto a todas las sugerencias que la gente hace. Los pruebo, si funcionan para mí, se quedan. También experimento de vez en cuando, lo que parece mejorar las cosas se queda conmigo.
№3. ¿Cómo lo mantienes? (De notas mentales, mantener un documento, usar una herramienta como StyleCop, etc.)
Recuerdo mi estilo y lo aplico automáticamente en todas partes.
Nota 1. Mantener un ojo abierto y una oreja aguda es extremadamente importante para mantenerse actualizado. Hace años aprendí de otros que la notación de Hungría era imprescindible, así que la seguí. Cuando la comunidad se dio cuenta de que no era tan bueno, cambié con todos.
Nota 2. A menudo no es tan importante qué elementos de estilo en particular adoptas, sino que mantienes tu estilo consistente a lo largo de tus códigos. Lo mismo se aplica para un equipo. Elija un estilo pero luego manténgalo.
Nota 3. Los estilos de codificación para diferentes idiomas pueden variar. C ++ merece un estilo, Java el otro. HTML y CSS tienen sus características requieren un estilo diferente nuevamente.
Nota 4. Sea cual sea el estilo que elija, comprenda y acepte que no funcionará al 100%. A veces tiene algún código que requiere un estilo diferente justo en el lugar, ya sea división multilínea, alineación diferente o lo que sea para mantener esa pieza de código en particular más legible. No empuje su estilo a todas partes, concéntrese en la legibilidad del código. Si es obvio, el estilo no funciona en este lugar en particular, haga una excepción.
Nota 5. No haga que seguir un estilo de código a una religión. Las herramientas que imponen un estilo de código son buenas, pero a veces pueden volverte loco. Por ejemplo, deshabilité el formato de código automático de Visual Studio porque me estaba volviendo loco. Si una herramienta se convierte en un obstáculo, solo agregue una excepción y no se preocupe de que su código no sea 100% compatible. Realmente no es tan importante y la perfección no se puede lograr de todos modos.
No creo que haya habido un momento en que dije: "Ok, este va a ser mi estilo". Céntrate en un entorno o lenguaje específico. Su estilo debe reflejar la forma en que enfrenta un determinado problema.
Trabajé en un equipo con un juego de código cerrado que me encantó y el desarrollador principal me guió, y me ayudó a mejorar mis habilidades después de que también se lo pregunté.
Sugirió, y adopté el estilo de codificación del Marco Zend (http://framework.zend.com/manual/en/coding-standard.html)
Terminé adoptando características de diferentes estilos, incluidos los estilos reflejados en MSDN. Luego configuro plantillas en VS que proporcionan mis #region/#endregionbloques y cualquier otra cosa que sea preferible.
Continúo estudiando otros estilos que encuentro a través de la investigación y la lectura. Si creo que hay algo que se destaca y podría mejorar mi estilo de legibilidad, mantenimiento u organización, lo pruebo. Si un nuevo ajuste de estilo está en orden, actualizaré las plantillas en VS o haré notas mentales.
Cuando codifico solo, busco la brevedad; La programación espartana puede ser completa, una locura de mierda ... Pero probablemente sea lo más cercano a mi credo.
Al codificar con otros, especialmente la codificación de mantenimiento, pretendo ser un camaleón: mis cambios deberían mejorar lo que modifican, sin mirar fuera de lugar.
¿Cómo definiste y encontraste tu estilo de codificación?
Al centrarse en la simplicidad y la legibilidad (¡legibilidad! == comprensibilidad, consulte Programación espartana )
¿Cómo sigues aumentando y mejorando?
Al revisar el código de los demás y el mío (e incluso los propios estándares de codificación).
¿Cómo lo mantienes? (De notas mentales, mantener un documento, usar una herramienta como StyleCop, etc.)
Utilizo dokuwiki , muy fácil de configurar (sin base de datos), estructura jerárquica, control granular (ACL listo para usar ), aspecto realmente agradable y bueno, es un wiki, para que cualquiera pueda contribuir. Además, las contribuciones / cambios están siempre bajo consenso y justificadas, basadas en la simplicidad y la legibilidad.
Esta es una respuesta un poco extraña, pero me tomó mucho tiempo realmente aprender la programación. Pasé mucho tiempo trabajando en 'las artes' antes de considerarme un programador.
Cuando codifico, tiendo a pensar en unidades como escribir: párrafos, frases, etc. Debido a esto, extenderé el código en más líneas en la búsqueda de hacerlo legible como una historia / ensayo / etc. Me molesta mucho cuando los desarrolladores intentan meter lo más posible en una línea o en un espacio pequeño, porque no logra nada más que hacer que el escritor se sienta inteligente y moleste a los futuros lectores.
Si necesito hacer algo extraño en aras de la eficiencia, lo comentaré para explicar por qué es así.
Probablemente no obtendré ningún voto a favor para esto, pero tal vez esto provocará alguna discusión de todos modos.
En cuanto al aspecto técnico, como la colocación de soportes y demás, los mantengo alineados porque el resultado es una mayor legibilidad.
1. How did you define and find your coding style?
Voy a adoptar una guía de estilo ya desarrollada, desarrollada en gran medida y ampliamente aceptada o popularizada por una gran empresa / proyecto.
Lo hago por varias razones, pero principalmente porque las guías de estilo pueden ser adoptadas inmediatamente por los desarrolladores. Una guía de estilo solo vale tanto como los desarrolladores están dispuestos a cumplirla.
Ejemplos de esto son PEP 8 de Python , la guía de estilo de Android para Java , la guía de estilo jQuery Core o la guía de estilo Python de Google .
2. How do you keep augmenting and improving it?
El mayor argumento para tales guías de estilo es que no fueron inventadas aquí y no inventadas por mí. Se necesitaron decenas de desarrolladores, líneas de código intimidantes y más tiempo del que su empresa / equipo estaría dispuesto a invertir para desarrollar y mantener una guía de estilo.
En cuanto a las mejoras, nunca ha habido una guía de estilo que responda de inmediato a todo lo que necesite saber. Pero, en la mayoría de los casos, las mejoras que he visto avanzar fueron solo una versión más detallada de lo que la guía de estilo ya allanó con su enfoque para escribir código.
En tales casos, cuando se encuentre con un bloque de extrañeza, debe pegarlo en una esencia o en alguna otra herramienta apropiada para compartir fragmentos de código con soporte de sintaxis de color y discutirlo en algún lugar con otros desarrolladores. Lo bueno es que, en tales casos, no está interesado en lo que hace el código, sino en cómo aparece el código, por lo que puede sacar ese bloque de contexto y discutir cómo debería mejorarlo, comparándolo con lo que ya se especificó en La guía de estilo como punto de partida principal para las discusiones.
3. How do you maintain it?
Bueno, lo mejor es que ya tendrá documentos existentes que se mantienen públicamente en línea.
Cuando se trata del formato de código, también puede hacer un esfuerzo adicional y proporcionarle a su equipo configuraciones de formateador para su editor favorito, lo que debería eliminar la incertidumbre y las conjeturas sobre el mantenimiento de las mejores apariencias. En realidad, no lo llamaría ir más allá, pero es una parte integral del desarrollo: no hay nada peor que hacer una diferencia donde el 90% de los cambios de código fue alguien que ingresó el código con el formato / estilo adecuado porque alguien olvidó limpiar antes de que cometieran una nueva característica enorme.
Si forma parte de un equipo, siempre debe cumplir con el estándar del equipo. Hay mucho que decir para usar un diseño genérico y no uno personal. Hace que su código sea más fácil de leer y comprender por otros, lo cual es esencial.