{"id":116,"date":"2020-08-12T09:53:00","date_gmt":"2020-08-12T09:53:00","guid":{"rendered":"https:\/\/softwareinformatico.com\/blog\/?p=116"},"modified":"2020-11-26T07:07:11","modified_gmt":"2020-11-26T07:07:11","slug":"comentarios-php","status":"publish","type":"post","link":"https:\/\/softwareinformatico.com\/blog\/comentarios-php\/","title":{"rendered":"Comentarios php"},"content":{"rendered":"\n

Para insertar comentarios php<\/strong> hay varias formas entre las que podemos elegir y depender\u00e1 de lo que queramos documentar para elegir una u otra.<\/p>\n\n\n\n

Hay que tener en cuenta que la documentaci\u00f3n de c\u00f3digo de programaci\u00f3n es recomendable y casi obligatoria para cualquier proyecto web<\/strong>.
Tanto por mantenimiento (si al cabo de 3-4 meses tienes que modificar el c\u00f3digo) como si trabajas en equipo para que el resto puedan entender qu\u00e9 hace cada m\u00f3dulo sin necesidad de estudiarlo en detalle.<\/p>\n\n\n\n

Comentarios Php de l\u00ednea<\/h2>\n\n\n\n

Por ejemplo, si queremos que sea para solo una l\u00ednea de texto, elegiremos el siguiente formato \/\/:<\/p>\n\n\n\n

\/\/Ejemplo: Aqu\u00ed ejecutamos la funci\u00f3n env\u00edo de email.<\/code><\/pre>\n\n\n\n
Documentaci\u00f3n para p\u00e1rrafos<\/h2>\n\n\n\n
En cambio, si lo que queremos son comentarios php de una gran extensi\u00f3n<\/strong> (varias l\u00edneas o p\u00e1rrafos explicando la funcionalidad de la clase, funci\u00f3n etc.) deber\u00edamos de usar la siguiente nomenclatura \/* *\/:<\/p>\n\n\n\n
\/*\n\tPara los comentarios php que vayan a usar varias l\u00edneas\n        deber\u00edamos de usar este formato.\n\n\tTambi\u00e9n podr\u00edamos insertar signos para llamar la atenci\u00f3n\n        o para diferenciar partes del fichero de c\u00f3digo si son\n        bastante extensos, por ejemplo\n\n\t*************************************************************\n\t*************************************************************\n\t\t\tPARTE INSERCI\u00d3N DEL USUARIO\n\n\t*************************************************************\n\t*************************************************************\n\n*\/<\/code><\/pre>\n\n\n\n
Cuando creamos aplicaciones inform\u00e1ticas<\/a>, es muy importante realizar una documentaci\u00f3n clara y concisa<\/strong>, ya que en un futuro cuando volvamos al script o si trabajamos en equipo, nos permitir\u00e1 conocer el funcionamiento solamente repasando los comentarios php.

Es importante no hacer comentarios especialmente largos, y que estos sean para entender el funcionamiento o porqu\u00e9 se utiliza un sistema u otro. El objetivo nunca deber\u00eda de ser explicar programaci\u00f3n, sino lo que hace y porqu\u00e9 lo hace<\/strong>.<\/p>\n\n\n\n
Comentarios php para clases y funciones<\/h2>\n\n\n\n
Para m\u00f3dulos recomendamos usar la siguiente estructura, que nos permitir\u00e1 seguir un est\u00e1ndar para todo aquel que acceda al c\u00f3digo:<\/p>\n\n\n\n
\/**\n * \t@access public\n * @param string $email.  Email para el usuario, no debe ser '' o null.\n * @return boolean. Si es una funci\u00f3n lo que puede devolver.\n * M\u00e9todo para dar de alta un usuario en el sistema\n\n *\/\n\n function alta_usuario($email){\n\n \t..............\n \t..............\n \treturn $boolean;\n }\n<\/code><\/pre>\n\n\n\n
Si necesitas ayuda, o tienes dudas sobre posicionamiento en google<\/a> o optimizaci\u00f3n web<\/a> preg\u00fantanos, podemos ayudarte.<\/p>
CONSULTA INFORMATICA<\/a><\/div><\/div>\n\n\n\n
Como \u00faltimo consejo, nunca programes sin antes tener todo bien planificado y organizado<\/strong>, luego docum\u00e9ntalo correctamente y crea la estructura correspondiente. <\/p>\n\n\n\n
Una vez tengas todo esto hecho podr\u00e1s programar y te resultar\u00e1 todo mucho m\u00e1s sencillo y r\u00e1pido, y por supuesto siempre haz comentarios php claros y entendibles por todo el mundo.

Esperamos que te haya parecido \u00fatil, un saludo.<\/p>\n","protected":false},"excerpt":{"rendered":"
Para insertar comentarios php hay varias formas entre las que podemos elegir y depender\u00e1 de lo que queramos documentar para elegir una u otra. Hay […]<\/a><\/p>\n<\/div>","protected":false},"author":1,"featured_media":124,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[10],"tags":[9],"class_list":["post-116","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-programacion-web","tag-php"],"_links":{"self":[{"href":"https:\/\/softwareinformatico.com\/blog\/wp-json\/wp\/v2\/posts\/116","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/softwareinformatico.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/softwareinformatico.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/softwareinformatico.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/softwareinformatico.com\/blog\/wp-json\/wp\/v2\/comments?post=116"}],"version-history":[{"count":0,"href":"https:\/\/softwareinformatico.com\/blog\/wp-json\/wp\/v2\/posts\/116\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/softwareinformatico.com\/blog\/wp-json\/wp\/v2\/media\/124"}],"wp:attachment":[{"href":"https:\/\/softwareinformatico.com\/blog\/wp-json\/wp\/v2\/media?parent=116"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/softwareinformatico.com\/blog\/wp-json\/wp\/v2\/categories?post=116"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/softwareinformatico.com\/blog\/wp-json\/wp\/v2\/tags?post=116"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}