PHPDoc

Cet article est une ébauche concernant l’informatique.

Vous pouvez partager vos connaissances en l’améliorant (comment ?) selon les recommandations des projets correspondants.
PHPDoc

Informations
Type Générateur de documentationVoir et modifier les données sur Wikidata
Site web www.phpdoc.de et www.phpdoc.orgVoir et modifier les données sur Wikidata

modifier - modifier le code - voir Wikidata (aide)

PHPDoc est une transposition de Javadoc au langage PHP. Il s'agit d'un standard formalisé pour commenter le code PHP. Il permet d'utiliser des outils tels que phpDocumentor ou Doxygen pour générer la documentation du code, notamment les méthodes publiques, les API, etc. Il permet aussi à certains IDE (Zend Studio (en), NetBeans, etc.) de connaître le type des variables et de lever d'autres ambiguïtés dues au typage faible, améliorant ainsi la complétion de code, le "typage objet"[1] et le débogage.

En , le PHP Framework Interoperability Group (PHP-FIG) commence à travailler sur le PSR-5, dérivé du standard de facto de phpDocumentor, pour développer et formaliser le standard PHPDoc[2].

Exemple

Les mots-clés PHPDoc commencent par une arobase[3]. Par exemple @return indique les types possibles de la valeur retournée par une méthode : 

 /**
  * @return string|null The file path or null when non-existent.
  */
 function getPath()
 {
     ...
     return $path;
 }

Références

  1. ↑ Documentation PHP FR : Typage objet
  2. ↑ PSR-5: PHPDoc (Draft)
  3. ↑ Site officiel
v · m
Personnalités
Ressources
Implémentations
Frameworks web
Test
Mapping objet-relationnel
Environnement de développement
Toolkit

Content Disclaimer

Informasi ini disarikan dari Wikipedia dan disajikan kembali untuk tujuan edukasi. Konten tersedia di bawah lisensi CC BY-SA 3.0. Kami tidak bertanggung jawab atas ketidakakuratan data yang bersumber dari kontribusi publik tersebut.

  1. The information displayed on this website is sourced in part or in whole from Wikipedia and has been adapted for the purpose of restating it. We strive to provide accurate and relevant information, however:
  2. There is no guarantee of absolute accuracy. Wikipedia is an open, collaborative project that can be edited by anyone, so information is subject to change.
  3. It is not intended to constitute professional advice. The content displayed is for informational and educational purposes only. For important decisions (e.g., medical, legal, or financial), please consult a professional.
  4. Content copyright. Wikipedia is licensed under the Creative Commons Attribution-ShareAlike License (CC BY-SA). This means that content may be reused with appropriate attribution and shared under a similar license.
  5. Responsible use. Any risk arising from the use of information from this website is entirely the responsibility of the user.