Foros del Web » Programando para Internet » PHP »

Comentarios con @ en algunos documentos?

Estas en el tema de Comentarios con @ en algunos documentos? en el foro de PHP en Foros del Web. ¡Hola a todos! Desde hace mucho tiempo he visto comentarios como el siguiente en archivos PHP, generalmente en CMS's como Joomla: Código PHP: /**  * @package    Joomla.Administrator ...
  #1 (permalink)  
Antiguo 28/11/2016, 14:35
Avatar de berkeleyPunk  
Fecha de Ingreso: febrero-2013
Ubicación: México :C
Mensajes: 565
Antigüedad: 11 años, 2 meses
Puntos: 22
Pregunta Comentarios con @ en algunos documentos?

¡Hola a todos!

Desde hace mucho tiempo he visto comentarios como el siguiente en archivos PHP, generalmente en CMS's como Joomla:
Código PHP:
/**
 * @package    Joomla.Administrator
 *
 * @copyright  Copyright (C) 2005 - 2016 Open Source Matters, Inc. All rights reserved.
 * @license    GNU General Public License version 2 or later; see LICENSE.txt
 */ 
En vista que el editor que uso siempre resalta la cadena que comienza con @, pienso que tal cadena tiene alguna relevancia y que está hecha para ser leída por algo, de modo que no es un simple comentario.

Hablando del ejemplo puesto arriba, ¿qué significan @package, @copyright y @license? ¿Son leídos por los browsers, por los .htaccess, por algo?

Saludos!
  #2 (permalink)  
Antiguo 28/11/2016, 15:52
Avatar de hhs
hhs
Colaborador
 
Fecha de Ingreso: junio-2013
Ubicación: México
Mensajes: 2.995
Antigüedad: 10 años, 9 meses
Puntos: 379
Respuesta: Comentarios con @ en algunos documentos?

Se le conoce como docblock y se utiliza para documentar el código. Generalmente es leido por los generadores de de documentación como sami y PhpDocumentor entre otros, tambien lo leen los ides para hacer auto completado.
como lectura adicional te dejo esto: https://www.phpdoc.org/docs/latest/index.html
__________________
Saludos
About me
Laraveles
A class should have only one reason to change.

Etiquetas: Ninguno
Atención: Estás leyendo un tema que no tiene actividad desde hace más de 6 MESES, te recomendamos abrir un Nuevo tema en lugar de responder al actual.
Respuesta




La zona horaria es GMT -6. Ahora son las 07:05.