{"id":956,"date":"2022-09-16T00:00:00","date_gmt":"2022-09-15T22:00:00","guid":{"rendered":"https:\/\/programaraciegas.net\/?p=956"},"modified":"2022-07-20T09:58:00","modified_gmt":"2022-07-20T07:58:00","slug":"codigo-limpio-con-comentarios-utiles","status":"publish","type":"post","link":"https:\/\/programaraciegas.net\/?p=956","title":{"rendered":"C\u00f3digo limpio con comentarios \u00fatiles"},"content":{"rendered":"<p>Un c\u00f3digo con buenos comentarios ayuda a su legibilidad como vimos en el art\u00edculo sobre <a href=\"https:\/\/programaraciegas.net\/?p=944\" rel=\"nofollow\">c\u00f3mo escribir c\u00f3digo limpio y legible<\/a>.<\/p>\n<p>Cada bloque de c\u00f3digo tiene un prop\u00f3sito, puede recibir par\u00e1metros y puede devolver un resultado. Toda esta informaci\u00f3n deber\u00eda estar explicada brevemente en un bloque comentado, preferentemente antes de los bloques de ejecuci\u00f3n. Por ejemplo:<\/p>\n<pre>\/\/ Funci\u00f3n calculaPrecioFinalDeCarrito<br \/><br \/>\/\/ \u00a0 \u00a0Calcula el precio final del carrito ajustando impuestos y conversi\u00f3n de moneda<br \/><br \/>\/\/<br \/><br \/>\/\/ Entrada: <br \/><br \/>\/\/ \u00a0 \u00a0lista de productos, tipo de impuestos, tipo de moneda<br \/><br \/>\/\/ Salida: <br \/><br \/>\/\/ \u00a0 \u00a0precio final a pagar por el cliente<br \/><br \/>function\u00a0calculaPrecioFinalDeCarrito(listaProductos, tipoDeImpuestos, tipoMoneda) {<br \/><br \/>\u00a0 \u00a0 var precioSinImpuestos = calculaPrecioDeListaDeProductos(listaProductos)<br \/><br \/>\u00a0 \u00a0 var\u00a0precioConImpuestos = calculaImpuestos(precioSinImpuestos, tipoDeImpuestos)<br \/><br \/>\u00a0 \u00a0 var precioFinal = convierteAMoneda(precioConImpuestos, tipoMoneda)<br \/><br \/>\u00a0 \u00a0 return\u00a0precioFinal<br \/><br \/>}<\/pre>\n<p>Pero se debe ser breve y evitar comentar todo lo que hace el c\u00f3digo l\u00ednea a l\u00ednea explicando s\u00f3lo lo esencial.<\/p>\n<p>Se debe explicar el porqu\u00e9 de las cosas y no c\u00f3mo se hacen. Un buen c\u00f3digo se da a entender por s\u00ed solo y no necesita extensos comentarios para ello.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Un c\u00f3digo con buenos comentarios ayuda a su legibilidad como vimos en el art\u00edculo sobre c\u00f3mo escribir c\u00f3digo limpio y legible. Cada bloque de c\u00f3digo tiene un prop\u00f3sito, puede recibir par\u00e1metros y puede devolver un resultado. Toda esta informaci\u00f3n deber\u00eda estar explicada brevemente en un bloque comentado, preferentemente antes de los bloques de ejecuci\u00f3n. Por &hellip; <\/p>\n<p class=\"link-more\"><a href=\"https:\/\/programaraciegas.net\/?p=956\" class=\"more-link\">Continuar leyendo<span class=\"screen-reader-text\"> \u00abC\u00f3digo limpio con comentarios \u00fatiles\u00bb<\/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":[8,6],"tags":[415,87],"class_list":["post-956","post","type-post","status-publish","format-standard","hentry","category-metodologiafilosofia","category-programacion","tag-codificacion","tag-programacion-2"],"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/programaraciegas.net\/index.php?rest_route=\/wp\/v2\/posts\/956","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/programaraciegas.net\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/programaraciegas.net\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/programaraciegas.net\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/programaraciegas.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=956"}],"version-history":[{"count":0,"href":"https:\/\/programaraciegas.net\/index.php?rest_route=\/wp\/v2\/posts\/956\/revisions"}],"wp:attachment":[{"href":"https:\/\/programaraciegas.net\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=956"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/programaraciegas.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=956"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/programaraciegas.net\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=956"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}