PHPackages                             headsnet/living-documentation - 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 & Helpers](/categories/utility)
4. /
5. headsnet/living-documentation

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

headsnet/living-documentation
=============================

Provides Living Documentation annotations

59.5k↑33.3%1[2 issues](https://github.com/headsnet/living-documentation/issues)1PHP

Since Feb 18Pushed 4y ago1 watchersCompare

[ Source](https://github.com/headsnet/living-documentation)[ Packagist](https://packagist.org/packages/headsnet/living-documentation)[ RSS](/packages/headsnet-living-documentation/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (1)

Living Documentation
====================

[](#living-documentation)

This package provides tools to aid in generation of Living Documentation in PHP projects.

Living Documentation has been championed by Cyrille Martraire and his book "Living Documentation" is the primary inspiration for this package.

Symfony integration is available via the [provided bundle](https://github.com/headsnet/living-documentation-bundle).

### Annotations

[](#annotations)

The package provides a set of annotations that can be used to semantically document a codebase, as well as provide inline documentation and learning resources for developers.

The annotations are grouped in to logical sets, such as:

- DDD artifacts
- Design Patterns

For example, you can annotate a DDD entity as follows:

```