php - remove - strip_tags wordpress

¿Qué significa @param en una clase?

Question

¿Qué significa el @param al crear una clase? Según tengo entendido, se usa para decirle al script qué tipo de datos son las variables y qué tipo de valor devuelve una función, ¿no es así? Por ejemplo:

/**
* @param string $some
* @param array $some2
* @return void
*/

No hay otra forma de hacerlo, estoy pensando en cosas como: void function() { ... } o algo así. Y para variables quiz (int) $ test;

Answer 1

@param es una parte del comentario de descripción que le indica cuál es el tipo de parámetro de entrada. No tiene nada que ver con la sintaxis del código. Use un editor de color compatible como Notepad ++ para ver fácilmente qué código y qué comentarios.

Answer 2

Como otros han mencionado, el @param al que se refiere es parte de un comentario y no es sintácticamente significativo. Simplemente está ahí para proporcionar sugerencias a un generador de documentación. Puede encontrar más información sobre las directivas admitidas y la sintaxis mirando el proyecto PHPDoc .

Hablando de la segunda parte de su pregunta ... Hasta donde sé, no hay una manera de especificar el tipo de retorno en PHP. Tampoco puede forzar que los parámetros sean de un tipo primitivo específico (cadena, entero, etc.).

Sin embargo, puede requerir que los parámetros sean una matriz, un objeto o un tipo específico de objeto a partir de PHP 5.1 o menos.

function importArray(array $myArray)
{
}

PHP lanzará un error si intentas y llamas a este método con cualquier cosa que no sea una matriz.

class MyClass
{
}
function doStuff(MyClass $o)
{
}

Si intenta llamar a doStuff con un objeto de cualquier tipo, excepto MyClass , PHP volverá a generar un error.

Answer 3

PHP es totalmente ajeno a los comentarios. Se utiliza para describir los parámetros que toma el método solo para hacer que el código sea más legible y comprensible.

Además, la buena práctica de códigos se dedica a usar ciertos nombres (como @param ), para los generadores de documentación.

Algunos IDE incluirán @param y otra información en la información sobre herramientas cuando se utilice el cursor sobre el método relevante.

Answer 4

Sé que esto es antiguo, pero solo como referencia, la respuesta a la segunda parte de la pregunta es ahora, PHP7 .

// this function accepts and returns an int
function age(int $age): int{
return 18;
}

Answer 5

@param no tiene un significado especial en PHP, normalmente se usa dentro de un comentario para redactar documentación. El ejemplo que has proporcionado muestra solo eso.

Si usa una herramienta de documentación, @summary el código para @param , @summary y otros valores similares (dependiendo de la sofisticación de la herramienta) para generar automáticamente documentación bien formateada para el código.