Evitar errores con buenos comentarios
Mucha gente despedir comentarios como un ejercicio diseñado para perder el tiempo. Pero los comentarios son en realidad muy valiosa para ayudar a recordar por qué lo hiciste algo de una determinada manera y para evitar las técnicas que no han funcionado en el pasado. Más allá de la documentación general, sin embargo, los comentarios pueden ayudar a evitar errores.
Los siguientes son algunos de los beneficios que se derivan de buenos comentarios:
Los comentarios pueden documentar las técnicas que tienen o no han funcionado en el pasado.
Puede utilizar los comentarios como medio para decirle a alguien con el propósito de un script, una función o método - la reducción de las posibilidades de utilizar el código incorrecto para una necesidad particular.
Un buen comentario dice por qué algo se hace de una manera determinada, que ayuda a asegurar que los cambios en el código no introducen errores.
Medios comentando completa documentación de entradas y salidas para que todos sepan cómo interactuar con un script, una función o método.
Sabiendo quién contactar acerca de un tema en particular es una primera línea de defensa contra los errores, porque el autor lo general se puede decir a alguien cómo evitar problemas.
Documentar el entorno en el que el código está diseñado para funcionar ayuda a entender cuando los errores son causados por cambios a otro software (y no el guión, función o método en sí).
La mejor política es evitar los errores siempre que pueda. Evitar un error siempre es menos costosa que la recuperación de un error. Sin embargo, el error más costoso de todo es que es fatal y hace que la aplicación se bloquee. Cuando las aplicaciones de choque, las personas pierden datos y organizaciones pierden clientes. La documentación apropiada ayuda a la gente a entender el código mejor y evitar errores antes de que ocurran (o incluso antes de que alguien puede pensar en una manera de hacer que el error en el primer lugar).
El mejor comentario en el mundo no puede evitar todos los errores. Algunos errores simplemente suceden, y no hay nada que puedas hacer al respecto. Por ejemplo, no se puede evitar un error que se produce como resultado de la caída de un rayo (errores en los datos introducidos por corriente eléctrica inducida en una conexión de red). A veces los fallos de hardware y software de terceros que MATLAB utiliza para realizar tareas pueden contener errores, también. Muchas fuentes de errores están fuera de su control, pero el uso de los comentarios efectivamente ayuda a reducir el número de errores que se pueden controlar.
Java Programación: errores de lanzamiento Es esencial que el código Java hace todo lo posible para solucionar un problema. Sin embargo, hay momentos en que su código simplemente no tiene suficiente información, recursos, derechos, o algún otro requisito para solucionar un…
Resumen rápido de los errores de captura en java Saber cuándo puede producirse un error en el programa Java es importante. Es necesario comprender que para buscar un problema particular en la aplicación. Sin embargo, también es importante entender Cómo se producen errores.El tipo de error…
Errores semánticos en java Muchas personas encuentran que la diferencia entre los errores semánticos y sintácticos (sintaxis) errores en el código de Java difícil de entender, pero son diferentes. Se puede ver un error semántico cuando la sintaxis de su código es…
Cómo hacer comentarios en javascript Comentarios de javascript son una manera que usted puede poner texto en un programa que no es una cadena o un comunicado. Esto puede no sonar tan grande, pero lo que hace comentarios tan importante y útil es, precisamente, que no causan…
Cómo utilizar texto en código javascript A diferencia de las cadenas en javascript, el contenido y la ortografía de texto fuera de las citas importa mucho. Cuando el texto no está rodeado de comillas (simples o dobles) en javascript, se considera parte del código del programa…
Cómo recuperarse de errores en matlab Todos cometemos errores, incluso con MATLAB. Se podría pensar que los expertos no cometen errores, pero cualquier experto que dice lo que definitivamente no es un experto. Cometer errores es parte del proceso de aprendizaje. También es parte del…
¿Cómo reducir errores con Xcode 4 Aunque algunos desarrolladores de iOS piensan que escribir código es donde pasan la mayor parte de su tiempo cuando están desarrollando una aplicación, la depuración es en realidad a la altura como un muy cercano segundo lugar.Debido a que la…
Cómo depurar el código en r Una vez que haya escrito el código en R, es importante saber cómo depurar ella. Errar es humano, y los programadores entran en esa " # 148 humana; categoría. Nadie logra escribir código sin errores, así que en vez de preguntarse si usted tiene…
¿Cómo generar tus propios mensajes de error en r La generación de sus propios mensajes Puede sonar extraño, pero en realidad se puede prevenir errores en R mediante la generación de sus propios errores. Recuerda el error lógico en el logitpercent () función? Hubiera sido más fácil de…
¿Cómo leer los errores y advertencias en r Si algo va mal con su código, R le dice. Hay que admitirlo: Estos mensajes de error pueden ser desde ligeramente confuso totalmente incomprensible si no estás acostumbrado a ellos. Pero no tiene por qué seguir así. Cuando usted se familiarice…
Encontrar y eliminar fuentes de error en la prueba de ciencias ged Se espera encontrar fuentes de error para el examen de GED Ciencia. Si los científicos eran perfectos, entonces cada experimento demostraría la hipótesis y ser reproducible por cualquier otro científico en cualquier momento. Por desgracia, los…
¿Cómo evitar errores al revitalizar la marca de su negocio Al revitalizar su marca para hacer frente a la realidad empresarial y de mercado actuales, evitar estos errores de marca de revitalización más comunes y navegar en la marca hacia el éxito. Los errores suceden cuando ¿no siga estos consejos:Como…