![\"Comentario](\"https:\/\/i2.wp.com\/karstieltopia.com\/wp-content\/uploads\/2016\/02\/comment.jpg?resize=300%2C48\")
\n<\/p>\n
Esta entrada es sobre una cosa que es muy importante pero que es totalmente in\u00fatil para tu programa, los comentarios en Java. Esta herramienta es algo que usar\u00e1s (o debieras) para pasar information entre humanos, solamente para ellos, nada para\u00a0cerebros inform\u00e1ticos.<\/p>\n
\n<\/p>\n
Los comentarios en Java (y en todos los lenguajes de programaci\u00f3n) son un elemento muy cr\u00edtico pero que est\u00e1n pensados solamente para los ojos de las personas que lean el c\u00f3digo fuente en d\u00f3nde se encuentran. Puedes poner lo \u00a0que quieras en los comentarios y no afectar\u00e1n en absoluto a la compilaci\u00f3n ni tampoco a la ejecuci\u00f3n de programa, pero realmente son muy importantes.<\/p>\n
Cuando est\u00e1s trabajando como desarrollador, en este caso como desarrollador Java, sabes lo que est\u00e1s haciendo (bueno, debieras saber que est\u00e1s haciendo), pero quiz\u00e1s algunos d\u00edas despu\u00e9s se te haya olvidado el porqu\u00e9 has hecho lo que has hecho (y de ah\u00ed salen los hijos bastardos). Puede ser que tengas muy buena memoria pero puedo asegurarte que olvidar\u00e1s un mont\u00f3n de detalles.<\/p>\n
Pero no solamente tienes que pensar en el escenario que te acabo de contar, tambi\u00e9n podr\u00eda ser que estuvieras leyendo el c\u00f3digo fuente de otro desarrollador y no tengas la m\u00e1s m\u00ednimo idea de porqu\u00e9 ha hecho algo ni que motivaci\u00f3n ten\u00eda para hacerlo as\u00ed.<\/p>\n
Por eso son tan importantes los comentarios, y m\u00e1s los comentarios en Java, dado que Java destaca por lo “verboso” que puede llegar a ser. Un comentario en Java solo es una herramienta para transmitir informaci\u00f3n de un humano a otro humano (o cualquier ente que pueda entender el lenguaje humano). Este comentario no va a ser ejecutado y no afectar\u00e1 en nada al sistema donde se ejecute.<\/p>\n
Vale pero, \u00bfc\u00f3mo son los comentarios en Java? B\u00e1sicamente se podr\u00eda decir que hay dos maneras de poner comentarios en Java:<\/p>\n
Por un lado, en bloque, tal como se puede ver en el siguiente ejemplo de c\u00f3digo:<\/p>\n
\/*\r\n El siguiente comando imprime el mensaje de Hello world\r\n *\/\r\nSystem.out.println(\"Hello world\");<\/pre>\nComo puedes ver, puedes poner cualquier cosa entre \/* y *\/<\/p>\n
Y por otro lado puedes poner una l\u00ednea como lo siguiente:<\/p>\n
\/\/ El siguiente comando imprime el mensaje de Hello world\r\nSystem.out.println(\"Hello world\");<\/pre>\nAqu\u00ed tienes que poner \/\/\u00a0por cada l\u00ednea de comentario.<\/p>\n
Y ya est\u00e1, ya saber todo lo que se puede saber sobre los comentarios en Java. Puedes ponerlos donde quieras y con el contenido que quieras. Pero normalmente se suelen seguir unas peque\u00f1as convenciones sobre los comentarios en Java. B\u00e1sicamente cosas como poner en el principio de una clase un comentario contando que hace esa clase; tambi\u00e9n se suelen poner comentarios antes de cada funci\u00f3n (sobre todo p\u00fablicas) y lo mismo para las variables.<\/p>\n
Generalmente en el mundo Jvaa se suele utilizar este tipo de comentarios para documentar todo, y por eso el sistema de documentaci\u00f3n que se utiliza, javadoc, est\u00e1 basado en los comentarios de Java. En una futura entrada, hablar\u00e9 sobre como funciona y como usar la herramienta javadoc para crear la documentaci\u00f3n, que tags se pueden utilizar y unas cuantas cosas m\u00e1s sobre ello.<\/p>\n
Por \u00faltimo me gustar\u00eda comentar una cosa. Poner comentarios es algo muy bueno, es algo que mejorar\u00e1 la experiencia de todo desarrollador al tocar un c\u00f3digo que no conoce, pero por favor, no utilices comentarios como lo siguiente:<\/p>\n
\/\/ Asignar a la variable a el resultado de uno m\u00e1s uno\r\nint a = 1 + 1;<\/pre>\nEl c\u00f3digo deber\u00eda comentarse a si mismo. Me explico, en el ejemplo anterior puedes ver que realmente no necesitas leer el comentario para saber que hace el c\u00f3digo. Utilizar comentarios para explicar porqu\u00e9 est\u00e1s haciendo algo y utiliza el c\u00f3mo solo para cuando ese algo que est\u00e1s haciendo es verdaderamente complicado entenderlo.<\/p>\n","protected":false},"excerpt":{"rendered":"
Esta entrada es sobre una cosa que es muy importante pero que es totalmente in\u00fatil para tu programa, los comentarios en Java. Esta herramienta es algo que usar\u00e1s (o debieras) para pasar information entre humanos, solamente para ellos, nada para\u00a0cerebros inform\u00e1ticos.<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"spay_email":"","jetpack_publicize_message":"","jetpack_is_tweetstorm":false},"categories":[22],"tags":[990,987],"jetpack_featured_media_url":"","jetpack_publicize_connections":[],"yoast_head":"\n
Comentarios en Java - Karstieltopia<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"http:\/\/karstieltopia.com\/programacion\/java\/comentarios-en-java\/\" \/>\n<meta property=\"og:locale\" content=\"es_ES\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Comentarios en Java - Karstieltopia\" \/>\n<meta property=\"og:description\" content=\"Esta entrada es sobre una cosa que es muy importante pero que es totalmente in\u00fatil para tu programa, los comentarios en Java. Esta herramienta es algo que usar\u00e1s (o debieras) para pasar information entre humanos, solamente para ellos, nada para\u00a0cerebros inform\u00e1ticos.\" \/>\n<meta property=\"og:url\" content=\"http:\/\/karstieltopia.com\/programacion\/java\/comentarios-en-java\/\" \/>\n<meta property=\"og:site_name\" content=\"Karstieltopia\" \/>\n<meta property=\"article:published_time\" content=\"2016-02-22T05:42:29+00:00\" \/>\n<meta property=\"og:image\" content=\"http:\/\/karstieltopia.com\/wp-content\/uploads\/2016\/02\/comment-300x48.jpg\" \/>\n<meta name=\"twitter:card\" content=\"summary\" \/>\n<meta name=\"twitter:creator\" content=\"@karstiel\" \/>\n<meta name=\"twitter:site\" content=\"@karstiel\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebSite\",\"@id\":\"http:\/\/karstieltopia.com\/#website\",\"url\":\"http:\/\/karstieltopia.com\/\",\"name\":\"Karstieltopia\",\"description\":\"Programaci\\u00f3n, tecnolog\\u00eda y a\\u00f1adidos\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":\"http:\/\/karstieltopia.com\/?s={search_term_string}\",\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"es\"},{\"@type\":\"ImageObject\",\"@id\":\"http:\/\/karstieltopia.com\/programacion\/java\/comentarios-en-java\/#primaryimage\",\"inLanguage\":\"es\",\"url\":\"https:\/\/i2.wp.com\/karstieltopia.com\/wp-content\/uploads\/2016\/02\/comment.jpg?fit=347%2C56\",\"width\":347,\"height\":56,\"caption\":\"Comentario en Java\"},{\"@type\":\"WebPage\",\"@id\":\"http:\/\/karstieltopia.com\/programacion\/java\/comentarios-en-java\/#webpage\",\"url\":\"http:\/\/karstieltopia.com\/programacion\/java\/comentarios-en-java\/\",\"name\":\"Comentarios en Java - Karstieltopia\",\"isPartOf\":{\"@id\":\"http:\/\/karstieltopia.com\/#website\"},\"primaryImageOfPage\":{\"@id\":\"http:\/\/karstieltopia.com\/programacion\/java\/comentarios-en-java\/#primaryimage\"},\"datePublished\":\"2016-02-22T05:42:29+00:00\",\"dateModified\":\"2016-02-22T05:42:29+00:00\",\"author\":{\"@id\":\"http:\/\/karstieltopia.com\/#\/schema\/person\/3d09a55c38c7c00e78c41fa3f71a6e75\"},\"inLanguage\":\"es\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"http:\/\/karstieltopia.com\/programacion\/java\/comentarios-en-java\/\"]}]},{\"@type\":\"Person\",\"@id\":\"http:\/\/karstieltopia.com\/#\/schema\/person\/3d09a55c38c7c00e78c41fa3f71a6e75\",\"name\":\"karstiel\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","jetpack_sharing_enabled":true,"jetpack_shortlink":"https:\/\/wp.me\/p6AuIG-BO","_links":{"self":[{"href":"http:\/\/karstieltopia.com\/wp-json\/wp\/v2\/posts\/2344"}],"collection":[{"href":"http:\/\/karstieltopia.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/karstieltopia.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/karstieltopia.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/karstieltopia.com\/wp-json\/wp\/v2\/comments?post=2344"}],"version-history":[{"count":1,"href":"http:\/\/karstieltopia.com\/wp-json\/wp\/v2\/posts\/2344\/revisions"}],"predecessor-version":[{"id":2349,"href":"http:\/\/karstieltopia.com\/wp-json\/wp\/v2\/posts\/2344\/revisions\/2349"}],"wp:attachment":[{"href":"http:\/\/karstieltopia.com\/wp-json\/wp\/v2\/media?parent=2344"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/karstieltopia.com\/wp-json\/wp\/v2\/categories?post=2344"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/karstieltopia.com\/wp-json\/wp\/v2\/tags?post=2344"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}