![]() It 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. This goes with the DRY principle and allows you only to document manually what is important. 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. There are clear advantages over phpDocumentor: 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. It is the standard recommended by the php PSR project. This is how you can use it with Doxygen generated documentation replacing default coloring. It works with a lot of languages and have nice themes, including Solarized. In my conception, copyright is designed for my 'company' (not real yet :P) name and license the way of what Im developing can be used: one of many CreativeCommons combinations, GNU, MIT, BSD, 'under license'. Use highlight.js for syntax highlighting in Doxygen generated documentation php doxygen highlight.js highlight.js is a nice Javascript library for syntax highlighting. I still think it makes sense to stick to phpDoc to document PHP code. Im moving my projects documentation from phpDoc to Doxygen, but I dont know how to write license and copyright together. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |