PHP Code Ratio, ou PHPCR de son petit nom, est un nouvel outil "basique" (dans la série des phpcpd, phpmd...) qui permet de connaître le pourcentage de commentaire dans vos fichiers php.

Installation

à partir du Channel PEAR

$ pear channel-discover pear.phppro.fr
$ pear install phppro/phpcr

mise à jour

$ pear upgrade phppro/phpcr

à partir du package compatible PEAR en téléchargement sur Google Code

$ wget http://phpcoderatio.googlecode.com/files/phpcr-0.1.0.tgz
$ pear install phpcr-0.1.0.tgz

Usage

Pour "passer" phpcr sur votre application, exécutez :

$ phpcr my-directory

ou bien pour exporter aussi le résultat sous forme xml :

$ phpcr --log-xml=phpcr-report.xml my-directory

Description des métriques calculées

  • Metrique 'code' : pourcentage de code php sans les espaces, sans les commentaires et sans le HTML "inline"
  • Metrique 'code-with-space' : pourcentage de code php avec les espaces mais sans commentaires et sans HTML "inline"
  • Metrique 'code-with-space-and-html' : pourcentage de code php avec espaces, HTML "inline" mais sans commentaire
  • Metrique 'html' : pourcentage de HTML "inline" dans les fichiers PHP
  • Metrique 'whitespace' : pourcentage d'espace dans les fichiers php

Extensions parsées

  • php
  • php3
  • php4
  • php5
  • phtml
  • inc

mais vous pouvez modifier cette liste en utilisant le paramètre ligne de commande "--suffixes="

Limitations

PHPCR est loin d'être un outil parfait et exhaustif, n'hésitez pas à remonter des éventuels bugs et des demandes d'évolutions sur l'espace du projet sur Google Code http://code.google.com/p/phpcoderatio/issues/list ! ou à partir la documentation sur http://code.google.com/p/phpcoderatio


Bonne utilisation !