{"id":204,"date":"2020-07-10T17:40:40","date_gmt":"2020-07-10T15:40:40","guid":{"rendered":"https:\/\/www.pythonparatodo.com\/?p=204"},"modified":"2020-07-10T17:40:41","modified_gmt":"2020-07-10T15:40:41","slug":"comentarios-y-docstrings","status":"publish","type":"post","link":"https:\/\/www.pythonparatodo.com\/?p=204","title":{"rendered":"Comentarios y Docstrings"},"content":{"rendered":"\n<p class=\"wp-block-paragraph\">Los comentarios est\u00e1n compuestos de una o mas l\u00edneas de texto que el int\u00e9rprete\u00a0ignora, y se usan, generalmente, para incluir comentarios relacionados con el c\u00f3digo o para documentarlo.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Para escribir comentarios de una sola l\u00ednea se usa el s\u00edmbolo # (almohadilla o en ingl\u00e9s hashkey).<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">La sintaxis es:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code lang=\"python\" class=\"language-python\"># comentario<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Este comentario puede estar aislado del c\u00f3digo como en el siguiente ejemplo:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code lang=\"python\" class=\"language-python\"># Se suman dos mas dos\ntotal = 2 + 2<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">O al final de una l\u00ednea de c\u00f3digo como en este otro:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code lang=\"python\" class=\"language-python\">total = 2 + 2 # total es igual a dos mas dos<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Se pueden escribir comentarios de varias l\u00edneas con la almohadilla, siempre que se incluya al principio como en el siguiente ejemplo:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code lang=\"python\" class=\"language-python\"># Funci\u00f3n sumar( param1, param2 )\n# param1: es el primer par\u00e1metro\n# param2: es el segundo par\u00e1metro<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Hay un caso especial para la almohadilla si esta se encuentra en la primera o segunda l\u00ednea del c\u00f3digo y contiene una expresi\u00f3n regular detr\u00e1s, ya que entonces el int\u00e9rprete la procesa como una declaraci\u00f3n de codificaci\u00f3n.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">El formato para cambiar la codificaci\u00f3n de caracteres es el siguiente:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code lang=\"python\" class=\"language-python\"># -*- coding: &lt;encoding-name> -*-<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Python 3 lee los caracteres en formato UFT-8 que es un formato de codificaci\u00f3n de caracteres que se ha convertido en un est\u00e1ndar universal usado cada vez m\u00e1s en el correo, las p\u00e1ginas web, bases de datos, etc.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Por ejemplo, para forzar el uso de UTF-8, se escribir\u00eda lo siguiente:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code lang=\"python\" class=\"language-python\"># -*- coding: utf-8 -*-<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Otro caso especial es cuando la almohadilla se encuentra en la primera l\u00ednea, y es seguida por un s\u00edmbolo de admiraci\u00f3n, seguida de la ruta del int\u00e9rprete. A esto\u00a0se le llama <strong>shebang<\/strong> y se usa en sistemas Linux para indicar a los scripts interpretados la ruta donde se encuentra el int\u00e9rprete, el cual procesar\u00e1 el c\u00f3digo.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">En Linux se suele usar&nbsp;<strong>env<\/strong>&nbsp;seguido del nombre del int\u00e9rprete as\u00ed:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code lang=\"python\" class=\"language-python\">#!\/usr\/bin\/env python3<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Siguiendo con los comentarios, cuando hay que incluir mas de una l\u00ednea se escribe el comentario, rodeado de tres comillas simples o dobles\u00a0<strong>\u00bb&#8217; comentario \u00bb&#8217;<\/strong>\u00a0o\u00a0<strong>\u00ab\u00bb\u00bb comentario \u00ab\u00bb\u00bb<\/strong>. Por ejemplo:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code lang=\"python\" class=\"language-python\">''' Esto es un comentario de\nvarias l\u00edneas.\nUsando comillas simples '''<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Python usa este \u00faltimo tipo de comentario para generar la ayuda online o <strong>docstrings<\/strong>, gracias al m\u00f3dulo\u00a0<strong>pydoc<\/strong>\u00a0que genera documentaci\u00f3n autom\u00e1tica para los m\u00f3dulos Python. Con este c\u00f3digo escrito en el int\u00e9rprete\u00a0de comandos de Python se puede observar un ejemplo, en el cual se crea una clase llamada <strong>Operaciones<\/strong> y se le a\u00f1ade un comentario entre comillas dobles el cual servir\u00e1 de ayuda de la clase y podremos ver si escribimos\u00a0<strong>help(Operaciones)<\/strong>.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code lang=\"python\" class=\"language-python\">>>> class Operaciones:\n...     \"\"\"\n...     Esta clase se llama Operaciones\n...     El m\u00e9todo suma, suma dos n\u00fameros\n...     El modo de uso es:\n...     objeto = Operaciones()\n...     objeto.suma( dato1 , dato2 )\n...     \"\"\"\n...     def suma(self , dato1 , dato2):\n...             \"\"\"\n...             Los par\u00e1metros de suma son: dato1 y dato2\n...             \"\"\"\n...             return dato1 + dato2\n... \n>>> help(Operaciones)\n\nHelp on class Operaciones in module __main__:\n\nclass Operaciones(builtins.object)\n |  Esta clase se llama Operaciones\n |  El m\u00e9todo suma, suma dos n\u00fameros\n |  El modo de uso es:\n |  objeto = Operaciones()\n |  objeto.suma( dato1 , dato2 )\n |  \n |  Methods defined here:\n |  \n |  suma(self, dato1, dato2)\n |      Los par\u00e1metros de suma son: dato1 y dato2\n |  \n |  ----------------------------------------------------------------------\n |  Data descriptors defined here:\n |  \n |  __dict__\n |      dictionary for instance variables (if defined)\n |  \n |  __weakref__\n |      list of weak references to the object (if defined)<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Gracias a esto, se puede leer la ayuda, y se puede entender, que la clase se llama Operaciones, que contiene una funci\u00f3n o m\u00e9todo que suma dos valores y que su forma de uso ser\u00eda instanciando la clase y llamando al m\u00e9todo suma de la instancia pas\u00e1ndole dos argumentos, que ser\u00e1n los n\u00fameros a sumar. Lo cual nos ayuda a entender c\u00f3mo usar la clase.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code lang=\"python\" class=\"language-python\">>>> objeto = Operaciones()\n>>> objeto.suma( 2 , 2 )\n4\n>>> objeto.suma( 2.4 , 35.2 )\n37.6<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"<p>Los comentarios est\u00e1n compuestos de una o mas l\u00edneas de texto que el int\u00e9rprete\u00a0ignora, y se usan, generalmente, para incluir &hellip; <\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[4],"tags":[93,90,89,94,91,92],"class_list":["post-204","post","type-post","status-publish","format-standard","hentry","category-python","tag-almohadilla","tag-ayuda","tag-comentario","tag-hashkey","tag-help","tag-shebang"],"_links":{"self":[{"href":"https:\/\/www.pythonparatodo.com\/index.php?rest_route=\/wp\/v2\/posts\/204","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.pythonparatodo.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.pythonparatodo.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.pythonparatodo.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.pythonparatodo.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=204"}],"version-history":[{"count":6,"href":"https:\/\/www.pythonparatodo.com\/index.php?rest_route=\/wp\/v2\/posts\/204\/revisions"}],"predecessor-version":[{"id":210,"href":"https:\/\/www.pythonparatodo.com\/index.php?rest_route=\/wp\/v2\/posts\/204\/revisions\/210"}],"wp:attachment":[{"href":"https:\/\/www.pythonparatodo.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=204"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.pythonparatodo.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=204"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.pythonparatodo.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=204"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}