PHPackages                             intrd/php-docbloc - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility &amp; Helpers](/categories/utility)
4. /
5. intrd/php-docbloc

ActiveLibrary[Utility &amp; Helpers](/categories/utility)

intrd/php-docbloc
=================

PHP docBloc - Generate 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).

1.1.x-dev(9y ago)342[1 issues](https://github.com/intrd/php-docbloc/issues)CC-BY-SA-4.0PHPPHP &gt;=5.3.0

Since May 19Pushed 9y ago1 watchersCompare

[ Source](https://github.com/intrd/php-docbloc)[ Packagist](https://packagist.org/packages/intrd/php-docbloc)[ Docs](http://github.com/intrd/php-docbloc)[ RSS](/packages/intrd-php-docbloc/feed)WikiDiscussions 1.1 Synced 4w ago

READMEChangelogDependenciesVersions (2)Used By (0)

docBloc - Generate and keep updated docBlock of your project files fetching details from composer.json and Git data. Supported filetypes: \*.php, \*.ini, \*.sh, \*.bat, \*.md (No Composer or PEAR needed to use this tool). Packageintrd/docblocVersion1.1Tagsdocblock, documentation, toolProject URLAuthorintrd (Danilo Salles) - Copyright(CC-BY-SA-4.0) 2016, intrdLicense[Creative Commons Attribution-ShareAlike 4.0](http://creativecommons.org/licenses/by-sa/4.0)Dependencies • php &gt;=5.3.0[![php-auto-docbloc](/imgs/php-auto-docbloc.gif?raw=true "php-auto-docbloc")](/imgs/php-auto-docbloc.gif?raw=true)

Composer.json sample
--------------------

[](#composerjson-sample)

docBloc fetch your project details from `composer.json`. If your project still does not have one, create it following sample below and put at your project root path.

```
{
    "name": "intrd/docbloc",
    "description": "PHP docBloc - Generate 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).",
    "keywords": ["php","docblock","documentation","tool"],
    "homepage": "http://github.com/intrd/docbloc",
    "authors": [
            {
                "name": "intrd (Danilo Salles)",
                "email": "x@dann.com.br",
                "homepage": "http://dann.com.br",
                "role": "Developer"
            }
        ],
    "license": "CC-BY-SA-4.0",
    "require": {
        "php": ">=5.3.0"
    },
    "autoload": {
        "psr-4": {
            "php\\":"src/"
        }
    },
    "extra": {
        "author_twitter":"intrd",
        "copyright_author":"intrd",
        "license_title":"Creative Commons Attribution-ShareAlike 4.0",
        "license_url":"http://creativecommons.org/licenses/by-sa/4.0"
    }
}

```

Docbloc triggers
----------------

[](#docbloc-triggers)

Each filetype have your own trigger, put this in the header of files that you want to docBloc manage.

PHP - Script

```
/** @docbloc **/

```

INI - Configuration file

```
;; @docbloc ;;

```

SH - Shell script

```
## @docbloc ##

```

BAT - Batch script

```
REM @docbloc REM

```

MD - Markdown files like README.md

```

```

Git details
-----------

[](#git-details)

(optional) I recommend you to control the versioning of your project by Git branch name. It's optional, but docbloc fetch version from .git/HEAD. If your project are not gitted, docbloc will not display the Version field at files.

Usage
-----

[](#usage)

Considering that you already have:

- PHP working
- Created/edited your `composer.json`
- Filled all files w/ the correct docBloc trigger
- (optional) a working .git/HEAD

Now go to your project root and run:

```
$ wget -O docbloc.php https://raw.githubusercontent.com/intrd/docbloc/1.1/src/docbloc.php && php docbloc.php && rm docbloc.php

```

[![running-docbloc](/imgs/run.png?raw=true "running-docbloc")](/imgs/run.png?raw=true)

It will download docbloc.php script, run and remove it.

Done, Every time you change any project detail at `composer.json` or create a new `git branch` version, simply run docBloc again to keep all your files docbloc header updated. Yes, it works recursively on upper directory levels too.

###  Health Score

20

—

LowBetter than 13% of packages

Maintenance13

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity44

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~246 days

Total

2

Last Release

3449d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/2204686?v=4)[intrd](/maintainers/intrd)[@intrd](https://github.com/intrd)

---

Top Contributors

[![intrd](https://avatars.githubusercontent.com/u/2204686?v=4)](https://github.com/intrd "intrd (26 commits)")

---

Tags

phpdocumentationdocblocktool

### Embed Badge

![Health badge](/badges/intrd-php-docbloc/health.svg)

```
[![Health](https://phpackages.com/badges/intrd-php-docbloc/health.svg)](https://phpackages.com/packages/intrd-php-docbloc)
```

###  Alternatives

[genericmilk/docudoodle

Generate documentation for your Laravel application using OpenAI

15428.7k](/packages/genericmilk-docudoodle)[godbout/dash-docset-builder

Dash (LOVE) Docset Builder in PHP (LOVE).

1263.6k](/packages/godbout-dash-docset-builder)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
