Cours PHP : Commentaires

exemple-commentaires.php

<?php

// Vous avez deux manières de mettre des commentaires.
// Celle-ci permet de mettre de petit commentaire quand c'est nécessaire.

/**
 * Et voici la seconde, on l'utilise surtout pour les fonctions et l'utilisation d'annotations !
 */

/**
 * Commentaire avec des annotations, elles n'ont aucun effet sur le code.
 *
 * Elles servent à documenter le code.
 *
 * @param string $name the name of the user.
 * @return string with an hello prefix.
 */
function getName(string $name): string
{
    return "Bonjour $name";
}

/**
 * Ici l'annotation "var" permet à l'IDE de connaître le type de la variable !
 */
class User
{
    /** @var string $name the name of the user. */
    private $name;
}

echo "Utilisez-les dès que vous en avez besoin !";