{"id":210,"date":"2018-01-20T17:43:07","date_gmt":"2018-01-20T17:43:07","guid":{"rendered":"http:\/\/escueladefrikis.com\/?p=210"},"modified":"2018-01-20T17:43:07","modified_gmt":"2018-01-20T17:43:07","slug":"buenas-practicas-programacion-comentarios-trazas","status":"publish","type":"post","link":"https:\/\/escueladefrikis.com\/index.php\/2018\/01\/20\/buenas-practicas-programacion-comentarios-trazas\/","title":{"rendered":"Buenas pr\u00e1cticas de programaci\u00f3n: comentarios y trazas"},"content":{"rendered":"<p>Los comentarios y las trazas son una ayuda inestimable que no debemos dejar de utilizar, tanto para ayudarnos a nosotros mismos como a los que nos sufren.<!--more--><\/p>\n<p>Los comentarios:<\/p>\n<ul>\n<li>Sirven para <strong>describir un trozo de c\u00f3digo<\/strong> y ayudarnos a comprender qu\u00e9 debe hacer cada parte de un programa. Es una <span style=\"text-decoration: underline;\">ayuda al programador<\/span>.<\/li>\n<li>Cuando revisemos despu\u00e9s de un tiempo un c\u00f3digo, posiblemente no nos acordemos exactamente c\u00f3mo funcionaba. Los comentarios nos ayudar\u00e1n a recordarlo.<\/li>\n<li>Si otra persona utiliza el c\u00f3digo, los comentarios le ayudar\u00e1 a saber qu\u00e9 hace y c\u00f3mo funciona.<\/li>\n<li>Con Arduino, los comentarios son como en Java:<\/li>\n<\/ul>\n<pre>\/\/ este es un comentario en una l\u00ednea<\/pre>\n<pre>\/*\u00a0Este es un comentario\ncon varias l\u00edneas\u00a0*\/<\/pre>\n<ul>\n<li>Si estamos realizando pruebas con nuestro c\u00f3digo, puede que en un momento dado queramos que no se ejecute una parte para realizar una prueba. La manera m\u00e1s sencilla de hacer que no se ejecute es a\u00f1adir <span style=\"font-family: 'courier new', courier, monospace;\">\u00ab\/*\u00bb<\/span> al principio y <span style=\"font-family: 'courier new', courier, monospace;\">\u00ab*\/\u00bb<\/span> al final y \u00a1listo! el c\u00f3digo no se ejecuta porque lo hemos \u00abcomentado\u00bb.<\/li>\n<\/ul>\n<pre>\/\/\u00a0No estoy seguro de qu\u00e9 operaci\u00f3n utilizar...\n\/*\nresult=a+b\nresult=a*b\n*\/\nresult=a-b<\/pre>\n<ul>\n<li>Nota sobre el comentario anterior: comenta c\u00f3digo s\u00f3lo para pruebas, no dejes c\u00f3digo comentado en un programa terminado.<\/li>\n<li>La parte mala: tanto los comentarios como el c\u00f3digo deber\u00edan estar en ingl\u00e9s. Lo siento hispano-hablantes, hemos perdido esta batalla \ud83d\ude41<\/li>\n<\/ul>\n<pre>\/\/\u00a0Not sure which operator I should use...\n\/*\nresult=a+b\nresult=a*b\n*\/\nresult=a-b<\/pre>\n<ul>\n<li>La parte buena: las bromas o chistes est\u00e1n permitidos \ud83d\ude42<\/li>\n<\/ul>\n<pre>\/\/\u00a0Not sure what the hell I am doing...\n\/*\nresult=a+b\nresult=a*b\n*\/\nresult=a-b<\/pre>\n<p>La traza o log:<\/p>\n<ul>\n<li>Sirve para <strong>saber qu\u00e9 est\u00e1 haciendo un\u00a0programa (o nuestro Arduino) durante la ejecuci\u00f3n<\/strong> mostrando informaci\u00f3n. Es una <span style=\"text-decoration: underline;\">ayuda a la persona que utiliza el c\u00f3digo\/soluci\u00f3n\/aparato<\/span>.<\/li>\n<li>Muchas veces la \u00fanica manera de saber que un programa\/aparato\/soluci\u00f3n est\u00e1 funcionando bien es mediante su traza.<\/li>\n<li>\u00a1Que sea \u00fatil! Escribe en traza lo suficiente, ni m\u00e1s ni menos.\n<ul>\n<li>Si escribes poca traza no sabr\u00e1s qu\u00e9 est\u00e1 haciendo.<\/li>\n<li>Si escribes demasiada traza te ser\u00e1 dif\u00edcil seguir la ejecuci\u00f3n porque tendr\u00e1s demasiada informaci\u00f3n.<\/li>\n<li>Un buen criterio es escribir una l\u00ednea de traza en cada bloque de c\u00f3digo relevante (por ejemplo, si un trozo de c\u00f3digo realiza una operaci\u00f3n compleja escribir en traza el resultado).<\/li>\n<\/ul>\n<\/li>\n<li>Ya vimos c\u00f3mo escribir traza con Arduino <a href=\"https:\/\/www.escueladefrikis.com\/2017\/02\/12\/logs-trazas-arduino-esta-programa\/\">aqu\u00ed<\/a>.<\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"<p>Los comentarios y las trazas son una ayuda inestimable que no debemos dejar de utilizar, tanto para ayudarnos a nosotros mismos como a los que nos sufren.<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[5],"tags":[12],"class_list":["post-210","post","type-post","status-publish","format-standard","hentry","category-programacion","tag-buenas-practicas"],"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/escueladefrikis.com\/index.php\/wp-json\/wp\/v2\/posts\/210","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/escueladefrikis.com\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/escueladefrikis.com\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/escueladefrikis.com\/index.php\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/escueladefrikis.com\/index.php\/wp-json\/wp\/v2\/comments?post=210"}],"version-history":[{"count":0,"href":"https:\/\/escueladefrikis.com\/index.php\/wp-json\/wp\/v2\/posts\/210\/revisions"}],"wp:attachment":[{"href":"https:\/\/escueladefrikis.com\/index.php\/wp-json\/wp\/v2\/media?parent=210"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/escueladefrikis.com\/index.php\/wp-json\/wp\/v2\/categories?post=210"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/escueladefrikis.com\/index.php\/wp-json\/wp\/v2\/tags?post=210"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}