Différences

Ci-dessous, les différences entre deux révisions de la page.

--- bloc2:prog:gen:netbeans-config [2023/03/30 11:04] – [Construire une copie de travail à partir d'un dépôt] admin
+++ bloc2:prog:gen:netbeans-config [2025/03/12 14:03] (Version actuelle) – [PHP Doc] admin
@@ Ligne 1: / Ligne 1: @@
 ====== NetBeans - Configuration ======
-===== Exécution pas-à-pas =====
+===== Exécution pas-à-pas en PHP =====
 Comme l'architecture web fait intervenir de multiples serveurs, l'exécution en mode pas-à-pas nécessite la mise en œuvre d'un logiciel intermédiaire supplémentaire. En effet, il faut bien un outil qui permette de commander les opérations à distance. \\ \\ Sur le marché, il existe deux outils : **Zend debugger** et **XDebug**. Nous utiliserons le second qu'il faut activer, paramétrer et lier à notre IDE :
 ==== Activation et paramétrage ====
-Ajouter les lignes suivantes à la fin du fichier **.\xampp\php\php.ini** que l'on peut atteindre via le **Control Panel** de Xampp (bouton Config d'Apache) :
+Tout d'abord, il faut disposer de la librairie XDebug dans le sous-dossier **ext** de PHP. Le fichier se nomme **php_xdebug.dll** et il est à choisir selon la version de PHP. Voir vos ressources sur le Bureau Windows. \\ \\
-  [XDebug]
+Ensuite, il faut ajouter les lignes suivantes à la fin du fichier **.\xampp\php\php.ini** que l'on peut atteindre via le **Control Panel** de Xampp (bouton Config d'Apache) :
-  zend_extension = "php_xdebug.dll"
+<code ini>
-  xdebug.remote_enable=on
+[XDebug]
-  xdebug.remote_handler=dbgp
+zend_extension=xdebug
-  xdebug.client_port=localhost
+xdebug.start_with_request=trigger
-  xdebug.remote_port=9003
+xdebug.mode=debug
-  xdebug.idekey="netbeans-xdebug"
+xdebug.client_host=localhost
+xdebug.client_port=9003
+xdebug.idekey="netbeans-xdebug"
+</code>
 Il est nécessaire de redémarrer Apache pour prendre en compte la nouvelle configuration.
-A titre de vérification, on pourra aller dans le **Dashboard de Xampp** et afficher **PHPInfo**. Dans la page de résultat, la recherche de __XDebug__ doit mener à une indication de son __n° de version__.
+A titre de vérification, on pourra aller dans le **Dashboard de Xampp** et afficher **PHPInfo**. Dans la page de résultat, la recherche de __XDebug__ doit mener à une indication de son __n° de version__. Le paramétrage qui précède vaut pour une version 3 de XDebug. Pour une version 2, il faut un autre paramètrage.
 ==== Lier à l'IDE ====
 |\\ \\ Dans NetBeans, aller dans le menu **Tools/Options/PHP/Debugging** et vérifier les :  \\ \\ <WRAP>
@@ Ligne 53: / Ligne 56: @@
 ==== Gérer les mises à jour, publications et les différentes versions ====
 Une fois la copie de travail extraite, on intervient sur ce projet comme sur tout projet dans l’IDE. Les opérations de versioning sont accessibles par clic droit dans le menu Subversion. On peut librement choisir d’appliquer ces opérations, soit au projet entier, soit à un dossier seulement, soit à un fichier isolé, selon l’objet sur lequel on applique le clic droit.
+==== Visualisation de l’état du versioning dans l’EDI ====
+Le lien suivant décrit les mises en forme, codes couleurs et icônes qui sont utilisés dans NetBeans pour éclairer l’état des différents fichiers d’un projet au regard du versioning :
+[[https://netbeans.apache.org/kb/docs/ide/subversion.html#_editing_sources]]
 ===== PHP Doc =====
 Pour générer l'auto-documentation du code en environnement PHP, il faut disposer d'un outil dédié hors NetBeans. Pour cela, **phpDocumentor** est conseillé. Ce produit se présente sous la forme d'un fichier PHAR (__PH__P __Ar__chive) et il suffit d'indiquer à NetBeans où le trouver :
-|Dans le menu **Tools / Options / PHP / Frameworks & Tools / phpDocumentor**|{{:bloc2:prog:gen:netbeans-config-phpdoc.png?400|phpDocumentor}}|
+|\\ \\ \\ \\ Dans le menu **Tools / Options / PHP / Frameworks & Tools / phpDocumentor**|{{:bloc2:prog:gen:netbeans-config-phpdoc.png?400|phpDocumentor}}|
-A partir de là, le menu contextuel "**Générer la documentation**" sera pleinement opérant et la documentation sera produite dans le dossier .xxx du projet.
+A partir de là, le menu contextuel du projet "**Générer la documentation**" sera pleinement opérant et la documentation sera produite dans un dossier qu'il reste à indiquer à la demande.
-Pourtant, en l'état, sur un projet CodeIgniter (ou tout autre framework), l'auto-documentation s'opérera sur l'ensemble du projet. Y compris les sources du framework. Pour limiter au strict nécessaire, on pourra s'appuyer sur un fichier de configuration à nommer phpdoc.dist et à placer à la racine du projet sur la base de l'exemple suivant :
+Pourtant, en l'état, sur un projet CodeIgniter (ou tout autre framework), l'auto-documentation s'opérera sur l'ensemble du projet. Y compris les sources du framework. Pour limiter au strict nécessaire, on pourra s'appuyer sur un fichier de configuration à nommer **phpdoc.dist.xml** et à placer **à la racine du projet** sur la base de l'exemple suivant :
-<code=xml phpdoc.dist.xml>
+<code xml phpdoc.dist.xml>
 <?xml version="1.0" encoding="UTF-8" ?>
 <phpdocumentor
@@ Ligne 71: / Ligne 79: @@
     <paths>
         <output>.phpdoc</output>
-        <cache>.phpdoc/cache</cache>
     </paths>
     <version number="latest">
@@ Ligne 85: / Ligne 92: @@
     </version>
     <setting name="graphs.enabled" value="false" />
-</phpdocumentor></code>
+</phpdocumentor>
+</code>
+Dans ce fichier de configuration, éventuellement à adapter, le dossier de stockage de la documentation est placé à la **racine du projet** et il est nommé **.phpdoc**. Le nom du dossier commençant par un point, il sera ignoré par le versioning. Ce qui est une bonne idée.
+Enfin, pour que le fichier XML soit pris en compte, il faut indiquer sa présence dans les propriétés du projet dans l'onglet **Documentation**.