Ultimamente tengo la sección Programación un poco olvidada y eso que es a lo que más me dedico, así que os dejo algunos consejos para comentar el código ya que, es una de las normas de programación básicas.
- Comenta todo
Es una buena opción comentar cada función, cada procedimiento, cada bloque... coméntalo todo, después de un tiempo sabrás qué hace cada cosa.
- Tabula igual todos los comentarios
- Al igual que es importante la tabulación del código lo es los bloques de comentarios. Ház un código ordenado y bonito visualmente.
- Comenta con criterio
- Los bloques comentados sirven para orientar al lector y no para comentar cosas muy obvias
- Corrección y Educación
- No uses lenguaje soez ni ofensivo, no conduce a nada más que a tener posibles problemas
- Sé Directo
- Ve al grano, no pierdas el tiempo adornando los comentarios, su función es aclarar el código no que te luzcas como poeta.
- Usa marcas especiales para las anotaciones
- Si el comentario no complementa el código si no que es un recordatorio de cosas por hacer o, bugs detectados, usa marcas especiales que aclaren su función.
- Comenta mientras programas
- Comentar es un proceso que debes hacer mientras vas programando, te facilitará la tarea y evitarás olvidos y pérdidas de tiempo intentando entender tu propio código
Con estos consejos comentarás mejor tu código y será mucho más facilmente mantenible.
Comentarios
Enviar un comentario nuevo