Suite à nos échanges sur la standardisation de la PHPDoc, j’ai mis à jour la documentation de la classe ajax pour la rendre conforme aux standards discutés.
Vous pouvez consulter :
- Les règles de documentation : jeedom-documentations/fr_FR/dev/php/phpdoc.md at feat/doc-phpdoc · kwizer15/jeedom-documentations · GitHub
- La PR correspondante : Documentation: Amélioration de la PHPDoc de la classe ajax selon les nouveaux standards by kwizer15 · Pull Request #3011 · jeedom/core · GitHub
Suite à cette première mise en application, j’ai quelques suggestions d’amélioration à proposer pour les règles :
- Gestion des méthodes dépréciées avec
@deprecated - Documentation des valeurs par défaut des paramètres
- Documentation des constantes de classe
- Clarification sur la documentation des paramètres optionnels
- Format pour les types union (ex:
array|string)
N’hésitez pas à me faire des retours sur ces propositions et les modifications apportées.