Cómo escribir código para mejorar la eficiencia

1. Composición tipográfica:

1. Agregue espacios apropiados entre palabras clave y operadores.

2. Agregue líneas en blanco entre bloques de programa relativamente independientes.

3. Las declaraciones, expresiones, etc. más largas deben escribirse en varias líneas.

4. Las nuevas líneas deben tener la sangría adecuada para que el diseño sea ordenado y las declaraciones sean legibles.

5. Las expresiones largas deben dividirse en nuevas líneas en operadores de baja prioridad, y los operadores deben colocarse al principio de la nueva línea.

6. Si hay expresiones o declaraciones largas en bucles, juicios, etc., se deben dividir adecuadamente.

7. Si los parámetros de la función o proceso son largos, se deben dividir adecuadamente.

8. No está permitido escribir varias declaraciones breves en una línea, es decir, solo escribir una declaración en una línea.

9. El comienzo de una función o procedimiento, la definición de una estructura y el código en declaraciones como bucles y juicios deben tener sangría.

10.El lenguaje C/C utiliza llaves '{' y '}' para definir un bloque de programa. Al escribir un bloque de programa, '{' y

'}' deben. usarse por separado en su propia fila y en la misma columna, alineados a la izquierda con la declaración que se refiere a ellos. Al comienzo del cuerpo de la función

, la definición de la clase, la definición de la estructura, la definición de la enumeración y los programas en if, for, do, while,

switch y case deben utilizar el método de sangría como se indica arriba.

2. Comentarios

1. Los comentarios deben ser simples y claros.

2. Comente mientras escribe el código, modifique el código y modifique los comentarios correspondientes al mismo tiempo para garantizar la coherencia entre los comentarios y el código.

3. Comentar cuando sea necesario y la cantidad de comentarios debe ser moderada. El contenido de la anotación debe ser claro y conciso, y el significado debe ser preciso para evitar ambigüedades en la anotación. Mantenga los comentarios adyacentes al código que describen, es decir, el principio de proximidad de los comentarios.

4. Los comentarios sobre el código deben colocarse junto al código de arriba, no debajo.

5. Los comentarios sobre la estructura de datos deben colocarse junto a ella, no debajo de ella; los comentarios sobre cada campo de la estructura

deben colocarse en la parte superior derecha de este campo. ; los comentarios en diferentes campos de la misma estructura deben estar alineados.

6. Los comentarios sobre variables y constantes deben colocarse junto a ellas o a la derecha encima de ellas.

7. Las variables globales deben tener comentarios más detallados, incluyendo descripciones de sus funciones, rangos de valores, qué funciones o procedimientos acceden a ellas

y precauciones al acceder a ellas, etc.

8. Debe haber la información de anotación necesaria al principio de cada archivo fuente, que incluye: nombre del archivo; autor; fecha de generación; descripción de la función; partes internas, la relación entre este archivo y otros archivos, etc.); lista de funciones o procesos principales y registros históricos de modificaciones de este archivo, etc.

9. Debe haber información de anotación necesaria delante de cada función o procedimiento, incluyendo: nombre de la función o procedimiento; descripción de la función de entrada, salida y valor de retorno; relación de llamada y relación llamada, etc.

3. Nombrar

1. Las palabras más cortas se pueden abreviar eliminando las "vocales"

2. la palabra La prioridad de varios símbolos y use paréntesis para aclarar el orden de operación de las expresiones para evitar el uso de la prioridad predeterminada.

3. Utilice la notación húngara

4. Legibilidad

1. Evite el uso de números que sean difíciles de entender y reemplácelos con símbolos significativos.

2. No utilice declaraciones difíciles de entender y muy técnicas.

3. Los códigos estrechamente relacionados en el programa fuente deben ser lo más adyacentes posible.

5. Variables

1. Eliminar variables públicas innecesarias.

2. Construya variables públicas que solo un módulo o función pueda modificar o crear, mientras que otros módulos o funciones relacionadas solo puedan acceder a ellas

para evitar que múltiples módulos o funciones diferentes puedan hacerlo todos. modificar y crear la misma variable pública.

3. Definir y aclarar cuidadosamente el significado, rol, rango de valores y relación entre las variables públicas.

4. Aclarar la relación entre la variable pública y la función o proceso que opera la variable pública, como acceso, modificación y creación, etc.

5. Al transferir datos a variables públicas, tenga mucho cuidado para evitar asignar valores irrazonables o salirse de los límites.

6. Evitar que las variables locales tengan el mismo nombre que las variables públicas.

7. Diseñe cuidadosamente la disposición y el orden de los elementos de la estructura para que la estructura sea fácil de entender, ahorre espacio y reduzca el

uso indebido.

8. El diseño de la estructura debe intentar considerar la compatibilidad futura y las futuras actualizaciones de versiones, y dejar espacio para algunas posibles aplicaciones futuras (como reservar algo de espacio, etc.).

9. Preste atención a los principios y detalles relacionados de lenguajes y compiladores específicos al manejar diferentes tipos de datos.

10. Está estrictamente prohibido utilizar variables no inicializadas. Inicializa las variables al declararlas.

11. Al programar, preste atención a la conversión forzada de tipos de datos.

6. Funciones y procedimientos

1. Intenta limitar el tamaño de la función a menos de 200 líneas.

2. Es mejor que una función complete solo una función.

3. Escribir funciones para funciones simples.

4. La función de la función debe ser predecible, es decir, debe producir la misma salida siempre que los datos de entrada sean los mismos.

5. Intente no escribir funciones que dependan de la implementación interna de otras funciones.

6. Evite diseñar funciones multiparamétricas y elimine los parámetros no utilizados de la interfaz.

7. Utilice comentarios para explicar en detalle la función, el rango de valores y la relación entre los parámetros de cada parámetro.

8. Comprobar la validez de todas las entradas de parámetros de la función.

9. Verifique la validez de todas las entradas no paramétricas de la función, como archivos de datos, variables públicas, etc.

10. El nombre de la función debe describir con precisión la función de la función.

11. Evite el uso de verbos poco claros o sin sentido para nombrar funciones.

12. El valor de retorno de la función debe ser claro y conciso para que los usuarios no puedan ignorar fácilmente las condiciones de error.

13/Borrar funciones funcionales e implementar el diseño de funciones con precisión (en lugar de aproximadamente).

14. Reducir las llamadas recursivas dentro de la propia función o entre funciones.

15. Al escribir una función reentrante, si se utilizan variables globales, se deben proteger desactivando interrupciones y semáforos (es decir, operaciones P, V)

y otros medios.

7. Capacidad de prueba

1. Antes de escribir código, los métodos y medios de depuración y prueba del programa deben diseñarse de antemano, y se deben diseñar varios ajustes.

Interruptores de prueba y códigos de prueba correspondientes, como funciones de impresión, etc.

2. Antes de realizar pruebas de integración/depuración conjunta del sistema, se deben construir el entorno de prueba, los proyectos de prueba y los casos de prueba y, al mismo tiempo,

analizar y optimizar cuidadosamente los casos de prueba. para mejorar la eficiencia de las pruebas.

8. Eficiencia del programa

1. Siempre preste atención a la eficiencia del código al programar.

2. Mejorar la eficiencia del código al tiempo que garantiza la corrección, estabilidad, legibilidad y capacidad de prueba del sistema de software.

3. No se puede perseguir ciegamente la eficiencia del código, lo que afectará la corrección, estabilidad, legibilidad y capacidad de prueba del software.

4. Al programar, siempre se debe prestar atención a la eficiencia del código; al optimizar el código, se debe considerar todo.

5. Construya con cuidado o escriba directamente en funciones de ensamblaje que se llamen con frecuencia o que tengan requisitos de rendimiento extremadamente altos.

6. Mejorar la eficiencia del espacio mejorando la división y organización de las estructuras de datos del sistema y optimizando los algoritmos del programa.

7. En bucles múltiples, el bucle más ocupado debe colocarse en el nivel más interno.

8. Minimizar los niveles de anidamiento de bucles.

9. Evite los bucles que contengan sentencias de juicio y coloque las sentencias de bucle dentro del bloque de código de las sentencias de juicio.

10. Intente utilizar la multiplicación u otros métodos en lugar de la división, especialmente la división en operaciones de punto flotante.

9. Garantía de calidad

1. Desarrollar la calidad del software durante el proceso de diseño del mismo.

Principio de prioridad de garantía de calidad del código

(1) La corrección significa que el programa debe lograr las funciones requeridas por el diseño.

(2) Estabilidad y seguridad se refieren a la estabilidad, confiabilidad y seguridad del programa.

(3) Comprobabilidad significa que el programa debe tener una buena capacidad de prueba.

(4) Estandarización/legibilidad significa que el estilo de escritura del programa, las reglas de nomenclatura, etc. deben cumplir con los estándares.

(5) La eficiencia global se refiere a la eficiencia general del sistema de software.

(6) La eficiencia local se refiere a la eficiencia de un determinado módulo/submódulo/función.

(7) La expresión personal/conveniencia personal se refiere a los hábitos de programación personales.

2. Haga referencia únicamente a su propio espacio de almacenamiento.

3. Evitar referencias al espacio de memoria liberado.

4. La memoria asignada en el proceso/función debe liberarse antes de que el proceso/función salga.

5. El identificador de archivo solicitado en el proceso/función (utilizado para abrir el archivo) debe cerrarse antes de que el proceso/función salga.

6. Evitar que las operaciones de memoria crucen fronteras.

7. Siempre preste atención a si la expresión se desborda o no.

8. Maneje con cuidado las diversas situaciones de error que pueda encontrar el programa.

9. Al comienzo de la operación del sistema, se deben inicializar las variables relevantes y el entorno operativo para evitar que se haga referencia a variables no inicializadas.

10. Al inicio de la operación del sistema, se debe verificar la consistencia de los datos cargados en el sistema.

11. Está estrictamente prohibido cambiar los ajustes y configuraciones relevantes de otros módulos o sistemas a voluntad.

12. La interfaz con otros módulos no se puede cambiar a voluntad.

13. Después de comprender completamente la interfaz del sistema, utilice las funciones proporcionadas por el sistema.

14. Siempre preste atención a los operadores confusos. Cuando termines de programar, deberás comprobar estos operadores de principio a fin.

15. No utilice declaraciones que estén estrechamente relacionadas con el hardware o el sistema operativo, sino utilice declaraciones estándar recomendadas.

16. Recomendación: cuando utilice kits de desarrollo de software o controles proporcionados por terceros, preste atención a los siguientes puntos:

(1) Comprender completamente la interfaz de la aplicación, el entorno de uso y el uso. tiempo Cosas a tener en cuenta.

(2) No creas demasiado en su corrección.

(3) A menos que sea necesario, no utilice paquetes de herramientas ni controles de terceros desconocidos.

10. Compilación de código

1. Al escribir código, asegúrese de guardarlo en cualquier momento y realizar una copia de seguridad periódicamente para evitar que el código se dañe debido a cortes de energía, daños en el disco duro, etc.

perdido.

2. Dentro del mismo grupo de proyectos, es mejor utilizar el mismo editor y utilizar las mismas opciones de configuración.

3. Diseñe razonablemente el directorio del sistema de software para que sea más fácil de usar para los desarrolladores.

4. Active todos los interruptores de advertencia del compilador para compilar el programa.

5. En el mismo grupo de proyectos o grupo de productos, las opciones de cambio de compilación deben estar unificadas.

6. Utilice software de herramientas (como Visual SourceSafe) para mantener la versión del código.

11. Pruebas y mantenimiento de código

1. Las pruebas unitarias requieren al menos cobertura de declaración.

2. Las pruebas unitarias comienzan rastreando cada declaración y observando cambios en el flujo de datos y las variables.

3. El código limpio, organizado u optimizado debe ser revisado y probado.

4. Las actualizaciones de la versión del código deben someterse a pruebas estrictas.