Una pregunta, ¿Cuándo creo una función PHP, como puedo hacer un enunciado o explicación de la función cuando la llamo? <strong>Ejemplo</...

Hola! Este es un ejemplo de una función en Laravel, lo que se hace es poner arriba antes de la función los comentarios que funcionan como documentación de la misma.

No se si eso responde tu pregunta :S

/***
     * @param Request $request
     * @return \Illuminate\Http\JsonResponse
     */
    public function logout (Request $request)
    {
        try {
            $request->user()->token()->revoke();

            return response()->json([
                'message' => 'Se ha cerrado la sesión',
                'data' => 'Se revoco el token'
            ]);
        } catch (\Throwable $th) {
            return response()->json([
                'error' => $th->getMessage(),
                'message' => 'Error en logout'
            ], 400);
        }
    }```