[PHP] Commentaires

[Thib4s]

Hello les gens je sais que c'est du chichi mais quelle est la différence entre

Code PHP :

<?php

# mon commentaire

// mon commentaire

?>

[srm]

Tout simplement que # est déprécié et ne dois plus être utilisé.

[Sephi-Chan]

Aucun. Le # est le commentaire historique des langages de scripts puisqu'il est utilisé dans le Shebang des systèmes Unix, qui permet de désigner le chemin vers l'interpréteur.

Ainsi, un script PHP sera déclaré ainsi :

#!/usr/bin/php



<?php

echo "Hello world!\n";

Alors qu'un script Ruby sera plutôt comme :

#!/usr/bin/ruby

puts "Hello World"

Tout cela permet (toujours sur un système Unix) d'exécuter les scripts sans se soucier de l'interpréteur.

Au lieu de faire :

ruby monsript.rb

php -e monscript.php

On peut faire directement

./monscript.rb

./monscript.php

Et cela prend encore plus son sens quand on n'utilise pas d'extension de fichier et qu'on place notre script dans le PATH, ça permet d'appeler de manière totalement transparente les scripts, et donc de se créer ses propres petits programmes facilement échangeables avec d'autres utilisateurs.

Donc il n'y a aucune différence, encore moins quand on utilise le langage pour le Web (où le Shebang n'est pas utile). La documentation de PHP utilise souvent le //, donc…


Sephi-Chan

---

Tout simplement que # est déprécié et ne dois plus être utilisé.

Seulement dans les fichiers INI et depuis PHP 5.3.

Cf. http://php.net/manual/en/migration53.deprecated.php

Comments starting with '#' are now deprecated in .INI files.

Sephi-Chan

[Thib4s]

Ha ok parce que personnellement j'utilise sa depuis longtemps comme modele de commentaire
description :

Code PHP :

<?php

#---------------------------------------------------------------------------

# Fonction index(int $nombre)

# Return false

# ... etc

#----------------------------------------------------------------------------

?>

[Sephi-Chan]

Dans ce cas tu es tranquille. Quitte à formater ainsi tes commentaires, pourquoi ne pas utiliser PHPDoc ?


Sephi-Chan

[Thib4s]

Heu j'aime pas les outils préfaits sa compte comme argument ? (a)
Non sérieusement j'ai pas besoin d'un truc aussi complet, PHPDoc c'est génial quand on crée quelque chose qui est destiné à devenir public mais en projet "fermé", c'est pas pareil
j'aime bien mes

Code PHP :

<?php

//---------------------------------------------------------------------------------\\

# BeforeFilter (global, return EXECUTE, mixte, all)

#===> Avant de charger les pages

//---------------------------------------------------------------------------------\\

function beforeFilter() { $this->set('PAGE_PART', 'project'); }





?>

[Sephi-Chan]

Dans ce cas, faire un encadrement, rappeler le prototype de la fonction, etc. n'est pas forcément utile. :p
Dans ton exemple, je dois avouer que le commentaire obscurcit plus le sens du code qu'il ne le clarifie : le nom de la méthode suffit, d'autant que c'est une fonctionnalité du framework déjà documenté.

Et puis… Ça craint un peu comme filtres, face aux originaux.


Sephi-Chan

[Thib4s]

Mouais pas faux mais il s'agit pas d'un prototype en fait mais des infos sur la fonction
global -> tout le controller peut l'utiliser
return EXECUTE -> on execute seulement le code
mixte -> les données son statiques ou dynamiques
all -> accès pour tous