Outils pour utilisateurs

Outils du site


bloc2:prog:gen:netbeans-config

Différences

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

Lien vers cette vue comparative

Les deux révisions précédentesRévision précédente
Prochaine révision
Révision précédente
bloc2:prog:gen:netbeans-config [2023/06/22 17:12] – [Activation et paramétrage] adminbloc2:prog:gen:netbeans-config [2025/03/12 14:03] (Version actuelle) – [PHP Doc] admin
Ligne 66: Ligne 66:
 |\\ \\ \\ \\ 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 un dossier qu'il reste à indiquer à la demande.+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.xml** 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 :
Ligne 95: Ligne 95:
 </code> </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. 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**.
  
  
bloc2/prog/gen/netbeans-config.1687446778.txt.gz · Dernière modification : 2023/06/22 17:12 de admin