Capacitación en Java de Beida Jade Bird: ¿Cómo estandarizar su propio método de edición de código?
Para los programadores, es muy importante desarrollar buenas habilidades de escritura de código.
Hoy, echemos un vistazo a los requisitos para la escritura de código estandarizado.
Espero que la lectura de este artículo pueda mejorar la comprensión de todos sobre las especificaciones del código.
1. Asegúrese de que no haya errores después de la compresión del código. Para proyectos JSP grandes, todos los archivos JSP contenidos en el proyecto generalmente se comprimirán cuando se lance el producto. Por ejemplo, se puede utilizar GoogleClosureCompilerService. el código. La nueva versión de jQuery tiene Utilice esta herramienta para comprimir el código. Esto generalmente eliminará los comentarios escritos durante el desarrollo, eliminará todos los espacios y nuevas líneas e incluso reemplazará los nombres de variables largos originales con nombres de variables cortos y sin sentido. El propósito de esto es acelerar las descargas de archivos y reducir el tráfico de datos adicional causado por el acceso al sitio web. También juega un pequeño papel en la protección del código. Al menos el código comprimido no es fácil de leer incluso si se restaura.
Para que el código se comprima correctamente, generalmente se requiere que la declaración termine normalmente con un punto y coma, y las llaves también deben terminar estrictamente, etc. Los requisitos específicos también dependen de los requisitos de la herramienta de compresión.
Entonces, si no lo hace de acuerdo con los estándares al principio, sería una pérdida de tiempo volver atrás y encontrar los errores después de que la compresión salga mal.
2. Asegúrese de que el código pueda pasar la función de formateo automático de un IDE específico. Generalmente, las herramientas de desarrollo relativamente completas (como Aptana Studio) tienen la función de "formato automático" del código. Para lograr saltos de línea y sangrías unificados, espacios y otros diseños de código, puede establecer sus estándares de formato favoritos, como si la llave izquierda { debe comenzar una nueva línea.
El propósito de lograr este requisito es facilitar que los miembros de su equipo de desarrollo tomen una copia de su código y usen el IDE para formatearlo automáticamente en un estilo que les guste o con el que estén familiarizados para leer.
Tu colega necesita leer tu código, tal vez porque escribes un método común, que también necesita usar en el proceso de desarrollo de otros módulos. Leer tu código puede brindarte una comprensión profunda del mismo. detalles de la llamada e implementación del método, que es un efecto que la documentación API simple no puede lograr.
3. El requisito de utilizar comentarios de documentos estándar se considera básico, lo que resulta útil para ver las indicaciones de transferencia de parámetros específicas del método en la llamada al método. También puede utilizar la herramienta de documentación de soporte para generar HTML o. otros formatos para el desarrollo La documentación es para que la lean otros miembros del equipo, puede intentar usar jsdoc-toolkit.
Si tu API generada automáticamente proviene de una plataforma abierta, como la aplicación facebook.com, entonces tu documento está abierto a todos los desarrolladores del mundo.
Además, escribir comentarios completos facilitará que los miembros del equipo lean su código. A través de la descripción de sus parámetros, los miembros del equipo podrán conocer fácilmente los detalles de implementación del método que escribió.
Por supuesto, también facilitará el mantenimiento futuro del código, de modo que no importa cuán grande sea el proyecto, si regresa y cambia algo después de mucho tiempo, no olvidará el código que escribió. ese tiempo fue.
4. Utilice nombres de variables estandarizados y significativos. El uso de nombres de variables estandarizados y significativos puede mejorar la legibilidad del código. Como miembro de desarrollo de un proyecto grande, el código que escribe no solo es fácil de leer para otros. entender.
Capacitación en informática/Piense en desarrollar grandes proyectos. De hecho, la cantidad de código escrito por cada persona puede ser relativamente grande. La denominación estándar lo hará claro y fácil de entender cuando revise su propio código. en el futuro, como futuras actualizaciones del sistema o nuevas funciones adicionales, es mucho más fácil modificar el código.
Sería una gran broma si al final descubres que el código que escribiste originalmente ahora es incomprensible.