Proposer une amélioration de commentaire

Le commentaire à poster est au format «docblock» (de phpDoc) qui peut être enrichi de tags spécifiques pour SPIP.
Fichier
ecrire/public/references.php
Fonction
collecter_balise_dynamique

    Nom ou pseudo de l'auteur de la proposition

Code original

/**
 * Construction du tableau des arguments d'une balise dynamique.
 *
 * Pour chaque argument (un nom de balise), crée le code PHP qui le calculera.
 *
 * @note
 *     Ces arguments peuvent être eux-même des balises (cf FORMULAIRE_SIGNATURE)
 *     mais gare au bouclage (on peut s'aider de `$nom` pour le réperer au besoin)
 *
 *     En revanche ils n'ont pas de filtres, donc on appelle `calculer_balise()` qui
 *     ne s'occupe pas de ce qu'il y a dans `$p` (mais qui va y ecrire le code)
 *
 * @uses calculer_balise()
 *     Pour obtenir le code d'éxécution de chaque argument.
 *
 * @param array $l
 *     Liste des noms d'arguments (balises) à collecter (chaque argument
 *     de la balise dynamique est considéré comme étant un nom de balise)
 * @param Champ $p
 *     AST au niveau de la balise
 * @param string $nom
 *     Nom de la balise
 * @return array
 *     Liste des codes PHP d'éxecution des balises collectées
 **/
function collecter_balise_dynamique($l, &$p, $nom) {
	$args = array();
	foreach ($l as $c) {
		$x = calculer_balise($c, $p);
		$args[] = $x->code;
	}
 
	return $args;
}

Le commentaire au format « docblock » peut être complété des éléments suivants sécifiques
à SPIP.

Sur un entête de fichier :

  • @package SPIP\Core\x (pour un fichier du core, x dépendant du fichier)
  • @package SPIP\Nom\x (pour un fichier de plugin, Nom étant le nom du plugin)

Sur un entête de fonction :

  • @pipeline x : indique que la fonction est une utilisation d’un pipeline
  • @pipeline_appel x : indique que la fonction appelle le pipeline indiqué
  • @balise : indique que la fonction est une compilation de balise
  • @filtre : indique un |filtre
  • @critere : indique que la fonction est une compilaiton de critère
  • @boucle : indique que la fonction est une compilaiton de boucle
Vous inscrire sur ce site

L’espace privé de ce site est ouvert aux visiteurs, après inscription. Une fois enregistré, vous pourrez consulter les articles en cours de rédaction, proposer des articles et participer à tous les forums.

Identifiants personnels

Indiquez ici votre nom et votre adresse email. Votre identifiant personnel vous parviendra rapidement, par courrier électronique.