freeCodeCamp/guide/spanish/documentation/index.md

1.1 KiB

title localeTitle
Code documentation Documentación del código

Documentación del código

La documentación del código es una forma en que los desarrolladores escriben su código para crear las mejores versiones de sus funciones posibles. Las Documentaciones de Código permiten que el novato se sienta cómodo con la costumbre del módulo, función, etc. para un lenguaje de programación particular. Siempre se recomienda ir con la Documentación antes de depurar su código, esto le ayuda a depurar de manera efectiva. Por ejemplo, debería poder pasar su código a un absoluto principiante y este podría comprender el código a través de los comentarios, nombres de variables apropiados y código de estructuración de manera espaciada y legible.

Puede convertirse en una idea extremadamente importante hacer un hábito de comentar sus funciones, bucles y declaraciones, y tratar los comentarios como parte del código fuente, tal como debería ser el código regular.

Un ejemplo de comentar en el mundo real.

Más información: