PHP Documentor 3
doctest
| PHP Documentor 3 | doctest | |
|---|---|---|
| 11 | 2 | |
| 4,034 | 8 | |
| 0.4% | - | |
| 9.0 | 3.7 | |
| 8 days ago | 5 months ago | |
| PHP | PHP | |
| MIT License | - |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
PHP Documentor 3
-
PHPDoc, PSR-5 and commenting inside the code
Also note that the tools ecosystem (IDEs and static analyzers such as PHPStan and Psalm) generally support more detailed types than you'll find in the RFC or the "official" PHPDocumentor project documentation, and they're continually evolving.
-
HOW TO USE RESTFUL RESOURCE CONTROLLERS IN LARAVEL
When running this command in your console, Artisan will create a new Controller in the app/Http/Controllers folder with some predefined methods, all these methods are related to API resources, all methods generated by the command have comments in the PHP DOCS standard (See More), with a brief description of each one's functionality.
-
Please, comment your code...
PHPDoc
-
I've noticed this syntax around - is there any "official" place where it comes from?
The original implementation, if I'm not wrong, was created by phpDocumentor, then it merged its codebase with a competing tool and now many programs contribute with their own annotations and formats.
-
Test your docblock code examples.
Another future project would be to see if it could be integrated in https://www.phpdoc.org/
-
What is the @ inside comments?
These are PHPDoc annotations. In addition to their original purpose of documenting code for humans, they're used by a range of other tools and IDEs to aid with things like type detection and other code enrichment.
-
Where can I find more information about how to write this type of comment about the different params and parts of a function? Example included
I think the original tool that implemented those annotations was phpDocumentor (if it wasn't the first, it was certainly among the pioneers), inspired by Javadoc. The original purpose was to generate documentation but, as it got popular, IDEs followed suit and started using annotations to provide code intelligence features. As of today, it's also used by code quality tools to identify potential bugs.
- Coisas que ninguém te ensina a fazer mas que todo mundo espera que você saiba: escrever documentação
-
Code documentation example for PHP projects
And the github repo: - github.com/phpDocumentor/phpDocumentor/
- Best documentation generator?
doctest
-
I wrote a library implementing the Option & Result types in PHP
the examples in the documentation are tested (that's why I built doctest a while ago
-
Test your docblock code examples.
For another pet project of mine (more on that one another day), I built a small tool that would find code examples inside PHP comments and execute them to ensure they are valid. It's called `doctest`: https://github.com/texthtml/doctest/
What are some alternatives?
PunBB - PunBB forum
phpDox - Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT)
FluxBB - FluxBB is a fast, light, user-friendly forum application for your website.
APIGen - PHP 7.1 ready Smart and Simple Documentation for your PHP project
vscode - 320+ color themes for Visual Studio Code.
doctum - A php API documentation generator, fork of Sami
swagger-ui - Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
Sami
daux.io - Daux.io is an documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way.
php-docbloc - Create and keep updated docBlock of your project files fetching details from composer.json and Git. Supported filetypes: *.php, *.ini, *.sh, *.bat, *.md (No Composer or PEAR need to be installed to use this tool).
HumHub - HumHub is an Open Source Enterprise Social Network. Easy to install, intuitive to use and extendable with countless freely available modules.
allourideas.org - allourideas allows groups to collect and priorize information in an open, democratic, and efficient process.