[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"project-8409":3},{"id":4,"name":5,"fullName":6,"owner":5,"repo":5,"description":7,"homepage":8,"htmlUrl":9,"language":10,"languages":9,"totalLinesOfCode":9,"stars":11,"forks":12,"watchers":13,"openIssues":14,"contributorsCount":15,"subscribersCount":15,"size":15,"stars1d":15,"stars7d":16,"stars30d":17,"stars90d":15,"forks30d":15,"starsTrendScore":15,"compositeScore":18,"rankGlobal":9,"rankLanguage":9,"license":19,"archived":20,"fork":20,"defaultBranch":21,"hasWiki":20,"hasPages":20,"topics":22,"createdAt":9,"pushedAt":9,"updatedAt":29,"readmeContent":30,"aiSummary":31,"trendingCount":15,"starSnapshotCount":15,"syncStatus":16,"lastSyncTime":32,"discoverSource":33},8409,"phpDocumentor","phpDocumentor\u002FphpDocumentor","Documentation Generator for PHP ","https:\u002F\u002Fwww.phpdoc.org",null,"PHP",4332,644,112,145,0,2,10,30.43,"MIT License",false,"master",[23,24,25,26,27,28],"docblock","docblocks","graphviz","hacktoberfest","php","phpdocumentor","2026-06-12 02:01:53","[![License: MIT](https:\u002F\u002Fimg.shields.io\u002Fbadge\u002FLicense-MIT-green.svg)](https:\u002F\u002Fopensource.org\u002Flicenses\u002FMIT)\n![Qa workflow](https:\u002F\u002Fgithub.com\u002FphpDocumentor\u002FphpDocumentor\u002Fworkflows\u002FQa%20workflow\u002Fbadge.svg)\n![Packagist Version](https:\u002F\u002Fimg.shields.io\u002Fpackagist\u002Fv\u002Fphpdocumentor\u002Fphpdocumentor?label=packagist%20stable)\n![Packagist Pre Release Version](https:\u002F\u002Fimg.shields.io\u002Fpackagist\u002Fvpre\u002Fphpdocumentor\u002Fphpdocumentor?label=packagist%20unstable)\n[![Downloads](https:\u002F\u002Fimg.shields.io\u002Fpackagist\u002Fdm\u002FphpDocumentor\u002FphpDocumentor.svg)](https:\u002F\u002Fpackagist.org\u002Fpackages\u002FphpDocumentor\u002FphpDocumentor)\n\n\nphpDocumentor\n=============\n\nWhat is phpDocumentor?\n----------------------\n\nphpDocumentor stands as the de-facto documentation tool for PHP projects, offering a robust solution for generating\ncomprehensive documentation effortlessly. By analyzing your PHP source code and DocBlock comments, phpDocumentor\ngenerates a complete set of API documentation, making it an indispensable tool for developers striving\nfor clear and well-documented codebases.\n\nBeyond its prowess in API documentation, phpDocumentor goes further by providing additional features.\nIt is equipped with the ability to create UML diagrams, making it a versatile tool for visualizing code structure.\nAdditionally, phpDocumentor offers a full-featured markup language parser, supporting both RestructuredText\nand Markdown syntax. This flexibility allows you to document your project using the markup language that best suits\nyour preferences.\n\nA notable feature of phpDocumentor is its capability to include parts of your API documentation directly into your\nRestructuredText documentation. This integration ensures that your documentation and code remain in sync, saving you\ntime and effort in maintaining accurate and up-to-date project documentation.\n\nInspired by its predecessors, phpDocumentor 1 and JavaDoc, phpDocumentor continues to innovate, staying up-to-date with\nthe latest technologies and PHP language features. This commitment ensures that developers have access to the best\npossible documentation experience, aligning with modern development practices.\n\nIn this guide, we will explore the various features of phpDocumentor, from its core functionality in generating\nAPI documentation to its advanced capabilities in parsing markup languages. Whether you're a beginner or an\nexperienced developer, phpDocumentor is your ally in creating well-documented, maintainable,\nand understandable PHP projects.\n\nphpDocumentor v3 (Stable)\n------------------------------------\n\nv3 is the latest stable release. \n\nDocumentation\n-------------\n\nFor more detailed information, you can check our online documentation at https:\u002F\u002Fdocs.phpdoc.org\u002F.\n\nFeatures\n--------\n\nphpDocumentor supports the following:\n\n* *PHP 7.0+ compatible*, full support for Namespaces, Closures and more are provided.\n* *Docblock over types*, docblocks can be more explicit about types not all formats are supported by native php.\n* *Shows any tag*, some tags add additional functionality to phpDocumentor (such as @link).\n* *Low memory usage*, peak memory usage for small projects is less than 20MB, medium projects 40MB, and large frameworks 100MB.\n* *Incremental parsing*, if you kept the Structure file from a previous run, you get an additional performance boost of up\n  to 80% on top of the mentioned processing speed increase above.\n* *Easy template building*, if you want to make a branding you only have to call 1 task and edit 3 files.\n* *Two-step process*, phpDocumentor first generates a cache with your application structure before creating the output.\n  If you'd like you can use that to power your own tools or formatters!\n* *Generics support*, with more static analysis in php types have become more complex. phpDocumentor understand these types. \n  And will render them as first class types.\n\nInstallation\n------------\n\nPhpDocumentor requires PHP 8.1 or higher to run.\nHowever, code of earlier PHP versions can be analyzed.\n\nAll templates provided with phpDocumentor have support for Class diagrams based on the read code base.\nThis will require the application [PlantUml] to be installed on the machine running phpDocumentor.\nRendering the class diagrams using [PlantUml] is optional, and warnings about missing [PlantUml] can be ignored.\nHowever, your documentation will contain some dead links in this case. \nClass diagram will be created with option `--setting=graphs.enabled=true`.\n\nThere are 4 ways to install phpDocumentor:\n\n1. Using phive (recommended)\n2. Using the PHAR (manual install)\n3. Via [Docker]\n4. Via [Composer]\n\n### Using Phive\n\n`$ phive install phpDocumentor --trust-gpg-keys 6DA3ACC4991FFAE5`\n\nFor more information about phive have a look at their [website](https:\u002F\u002Fphar.io\u002F).\nNow you have phpDocumentor installed, it can be executed like this:\n\n`php tools\u002FphpDocumentor`\n\n### Using the PHAR\n\n1. Download the phar file from https:\u002F\u002Fgithub.com\u002FphpDocumentor\u002FphpDocumentor\u002Freleases\n2. You can execute the phar like this: `php phpDocumentor.phar`\n\n### Via Docker\n\n1. `$ docker pull phpdoc\u002Fphpdoc`\n2. `$ docker run --rm -v $(pwd):\u002Fdata phpdoc\u002Fphpdoc`\n\n### Via Composer (not recommended)\n\nBut wait? What about composer?\n\nAh, you discovered our secret. There is a phpdocumentor composer package that you can use to install phpDocumentor.\n\nHowever: phpDocumentor is a complex application, and its libraries are used in countless other libraries and applications (2 of our libraries have more than 150 million downloads each); and this means that the chances for a conflict between one of our dependencies and yours is high. And when I say high, it is really high.\n\nSo, because of the above: we do not endorse nor actively support installing phpDocumentor using Composer.\n\nHow to use phpDocumentor?\n-------------------------\n\nThe easiest way to run phpDocumentor is by running the following command:\n\n    $ phpdoc run -d \u003CSOURCE_DIRECTORY> -t \u003CTARGET_DIRECTORY>\n\nThis command will parse the source code provided using the `-d` argument and output it to the folder indicated by the `-t` argument.\n\nphpDocumentor supports a whole range of options to configure the output of your documentation.\nYou can execute the following command, or check our website, for a more detailed listing of available command-line options.\n\n    $ phpdoc run -h\n\nConfiguration file(s)\n---------------------\n\nphpDocumentor also supports the use of configuration files (named phpdoc.xml or phpdoc.dist.xml by default).\nPlease consult the documentation to see the format and supported options.\n\n### Nightly builds\n\nPhpDocumentor doesn't have nightly releases.\nHowever, during each pipeline a phar artifact is built.\nIf you want to test the bleeding edge version of phpDocumentor, have a look in the [actions] section of this repository.\nEach successful QA workflow has an Artifacts section at the bottom with the phar artifact built.\n\nContact\n-------\n\nReaching out to us is easy, and can be done with:\n\n* Twitter: [@phpDocumentor]\n* Website: https:\u002F\u002Fwww.phpdoc.org\n* GitHub:  https:\u002F\u002Fwww.github.com\u002FphpDocumentor\u002FphpDocumentor\n* E-mail:  [mike@phpdoc.org]\n\n[@phpDocumentor]: https:\u002F\u002Ftwitter.com\u002FphpDocumentor\n[v2 branch]: https:\u002F\u002Fgithub.com\u002FphpDocumentor\u002FphpDocumentor\u002Ftree\u002F2.9\n[Graphviz]: https:\u002F\u002Fwww.graphviz.org\u002Fdownload\u002F\n[actions]: https:\u002F\u002Fgithub.com\u002FphpDocumentor\u002FphpDocumentor\u002Factions?query=workflow%3A%22Qa+workflow%22+is%3Asuccess\n[Docker]: https:\u002F\u002Fhub.docker.com\u002Fr\u002Fphpdoc\u002Fphpdoc\u002F\n[Composer]: https:\u002F\u002Fgetcomposer.org\u002F\n[mike@phpdoc.org]: mailto:mike@phpdoc.org\n","phpDocumentor 是一个专为 PHP 项目设计的文档生成工具，能够通过分析 PHP 源代码和 DocBlock 注释自动生成全面的 API 文档。其核心功能包括支持 PHP 7.0 及以上版本、提供对命名空间和闭包等现代 PHP 特性的完全支持，并且可以通过 DocBlock 更明确地指定类型。此外，phpDocumentor 还具备创建 UML 图表的能力，进一步增强了代码结构的可视化。它还支持 RestructuredText 和 Markdown 两种标记语言，允许开发者根据个人偏好选择适合的文档格式。该工具特别适用于需要清晰、易于维护代码库的 PHP 项目开发场景中，无论是初学者还是经验丰富的开发者都能从中受益。","2026-06-11 03:17:49","top_language"]