{"id":426,"date":"2008-01-07T22:01:32","date_gmt":"2008-01-07T20:01:32","guid":{"rendered":"http:\/\/www.marblestation.com\/blog\/?p=426"},"modified":"2012-04-26T16:30:36","modified_gmt":"2012-04-26T14:30:36","slug":"reglas-para-comentar-codigo","status":"publish","type":"post","link":"https:\/\/www.marblestation.com\/?p=426","title":{"rendered":"Reglas para comentar c\u00f3digo"},"content":{"rendered":"

Hace unos d\u00edas fu\u00ed a parar a un enlace bastante interesante donde se enumeran diversos consejos para comentar c\u00f3digo<\/a> de la forma m\u00e1s elegante posible (autor Jos\u00e9 M. Aguilar). Resumen:<\/p>\n

    \n
  1. Comenta a varios niveles: Al inicio de una clase, de un m\u00e9todo, etc.<\/li>\n
  2. Usa p\u00e1rrafos comentados: No redactar lineas kilom\u00e9tricas, utilizar p\u00e1rrafos.<\/li>\n
  3. Tabula por igual los comentarios de l\u00edneas consecutivas: Si tenemos 2 l\u00edneas de c\u00f3digo de longitudes diferentes y en cada una a\u00f1adimos un comentario, que estos se encuentren alineados el uno respecto al otro.<\/li>\n
  4. No insultes la inteligencia del lector: No comentar las obviedades.<\/li>\n
  5. S\u00e9 correcto: Los comentarios ofensivos o las bromas no tienen porque ser del agrado de todo el mundo, hay que limitarse a comentar de forma neutral.<\/li>\n
  6. No pierdas el tiempo: Estilo directo, conciso y claro.<\/li>\n
  7. Utiliza un estilo consistente: Definir quien va a ser el destinatario de los comentarios (programadores expertos, usuarios, etc.) y redactar en consecuencia a trav\u00e9s de todo el c\u00f3digo.<\/li>\n
  8. Para los comentarios internos usa marcas especiales: Por ejemplo, utilizar la palabra TODO siempre que quieras indicar que falta por implementar alguna caracter\u00edstica.<\/li>\n
  9. Comenta mientras programas: No dejes para ma\u00f1ana lo que puedas hacer hoy, de lo contrario te costara el doble y tendr\u00e1 la mitad de calidad.<\/li>\n
  10. Comenta como si fuera para t\u00ed mismo.<\/li>\n
  11. Actualiza los comentarios a la vez que el c\u00f3digo<\/li>\n
  12. La regla de oro del c\u00f3digo legible: Deja que el c\u00f3digo hable por si mismo, de esta forma podr\u00e1s minimizar los comentarios a escribir.<\/li>\n<\/ol>\n

    Os dejo con otro art\u00edculo que tambi\u00e9n habla del tema<\/a> (y otro m\u00e1s<\/a>). \u00bfA\u00f1adir\u00edais alg\u00fan otro consejo?<\/p>\n","protected":false},"excerpt":{"rendered":"

    Hace unos d\u00edas fu\u00ed a parar a un enlace bastante interesante donde se enumeran diversos consejos para comentar c\u00f3digo de la forma m\u00e1s elegante posible (autor Jos\u00e9 M. Aguilar). Resumen: Comenta a varios niveles: Al inicio de una clase, de un m\u00e9todo, etc. Usa p\u00e1rrafos comentados: No redactar lineas kilom\u00e9tricas, utilizar p\u00e1rrafos. Tabula por igual … Continue reading Reglas para comentar c\u00f3digo<\/span> →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1,6],"tags":[],"class_list":["post-426","post","type-post","status-publish","format-standard","hentry","category-espanyol","category-tecnologia"],"_links":{"self":[{"href":"https:\/\/www.marblestation.com\/index.php?rest_route=\/wp\/v2\/posts\/426","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.marblestation.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.marblestation.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.marblestation.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.marblestation.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=426"}],"version-history":[{"count":1,"href":"https:\/\/www.marblestation.com\/index.php?rest_route=\/wp\/v2\/posts\/426\/revisions"}],"predecessor-version":[{"id":1276,"href":"https:\/\/www.marblestation.com\/index.php?rest_route=\/wp\/v2\/posts\/426\/revisions\/1276"}],"wp:attachment":[{"href":"https:\/\/www.marblestation.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=426"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.marblestation.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=426"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.marblestation.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=426"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}