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/base/objets.php
Fonction
base_serial

    Nom ou pseudo de l'auteur de la proposition

Code original

/**
 * Déclare les tables principales du Core
 *
 * Tables principales, hors objets éditoriaux.
 *
 * @param array $tables_principales
 *     Description des tables principales déjà déclarées
 * @return void
 **/
function base_serial(&$tables_principales) {
 
	$spip_jobs = array(
		'id_job' => 'bigint(21) NOT NULL',
		'descriptif' => "text DEFAULT '' NOT NULL",
		'fonction' => 'varchar(255) NOT NULL', //nom de la fonction
		'args' => "longblob DEFAULT '' NOT NULL", // arguments
		'md5args' => "char(32) NOT NULL default ''", // signature des arguments
		'inclure' => 'varchar(255) NOT NULL', // fichier a inclure ou path/ pour charger_fonction
		'priorite' => 'smallint(6) NOT NULL default 0',
		'date' => "datetime DEFAULT '0000-00-00 00:00:00' NOT NULL", // date au plus tot
		'status' => 'tinyint NOT NULL default 1',
	);
 
	$spip_jobs_key = array(
		'PRIMARY KEY' => 'id_job',
		'KEY date' => 'date',
		'KEY status' => 'status',
	);
 
	/// Attention: mes_fonctions peut avoir deja defini cette variable
	/// il faut donc rajouter, mais pas reinitialiser
	$tables_principales['spip_jobs'] = array('field' => &$spip_jobs, 'key' => &$spip_jobs_key);
}

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.