3/27/2023 0 Comments Doxygen phpIt simplifies work and gives relief.įor me documentation is crucial, therefore it is difficult to understand that PHP Framework Interop Group issues recommendations about documentation, that no documentation generator compies to. Having a complete documentation of the code is a must. the recommended way to describe hashes is not understood by phpDocumentor). is deprecated in favor of but doxygen understands only is necessary, but doesn't exist as tag phpDoc.īut phpDocumentor does not honour phpDoc standard neither (e.g.The only drawback I found is that you cannot stick 1 to 1 to the PSR-5 standard proposal : You can document the bigger picture and let Doxygen enumerate all function arguments. Most of the code style rules can be automatically fixed, or at least detected, by PHPCodeSniffer (aka PHPCS), using a custom ruleset for MediaWiki. If you would like a short checklist to help you review your commits, try using the Pre-commit checklist. This goes with the DRY principle and allows you only to document manually what is important. See also the general conventionsthat apply to all program languages, including PHP. This allows you to get a complete doc of all classes, functions and vars in the project, without starting to document. Page level docblocks work out of the box (starting the docblock with It is possible to document all entities, even thoug they have no doc.Flexibility: there are many more options with doxygen.There is no need to deal with hosts of bugs. This package provides PHPDoc support for Doxygen.It contains: doxygen-phpdoc-filter. There are clear advantages over phpDocumentor: The creator of Doxygen, Dimitry van Heesch, maitains a Doxygen web site that has latest releases, manuals, mailing lists, articles, and many other resources for Doxygen users and developers. It is also generalized into the annotations concept, as it is used for instance in Doctrine.Īnother argument for phpDoc is that Javascript and many other languages have it's analoguos commenting system.Īfter much time spent to try to get phpDocumentor work, I generated the documentation with Doxygen. Doxygen is a documentation software for a variety of programming languages, including C++, C, Java, Objective-C, PHP, Python, Fortran, and C. It is the standard recommended by the php PSR project. I still think it makes sense to stick to phpDoc to document PHP code.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |