https://github.com/php-annotations/php-annotations

Industrial-strength annotations for PHP
https://github.com/php-annotations/php-annotations

annotations php

Last synced: 9 days ago
JSON representation

Industrial-strength annotations for PHP

• Host: GitHub
• URL: https://github.com/php-annotations/php-annotations
• Owner: php-annotations
• License: lgpl-3.0
• Created: 2011-08-12T18:30:43.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2024-03-31T14:46:46.000Z (9 months ago)
• Last Synced: 2024-10-30T03:42:53.331Z (about 1 month ago)
• Topics: annotations, php
• Language: PHP
• Homepage:
• Size: 388 KB
• Stars: 138
• Watchers: 9
• Forks: 36
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Roadmap: docs/Roadmap.rst

Awesome Lists containing this project

• php-awesome - php-annotations - 代码注解解析 (类库 / API文档)

README

        
# php-annotations

[![Join the chat at https://gitter.im/php-annotations/php-annotations](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/php-annotations/php-annotations?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![CI](https://github.com/php-annotations/php-annotations/actions/workflows/tests.yml/badge.svg)](https://github.com/php-annotations/php-annotations/actions/workflows/tests.yml)

[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/php-annotations/php-annotations/badges/quality-score.png?s=41628593655dae3740c3a64f172438430ee26b84)](https://scrutinizer-ci.com/g/php-annotations/php-annotations/)

[![codecov](https://codecov.io/gh/php-annotations/php-annotations/graph/badge.svg?token=iAB52dISoO)](https://codecov.io/gh/php-annotations/php-annotations)

[![Latest Stable Version](https://poser.pugx.org/mindplay/annotations/v/stable.svg)](https://packagist.org/packages/mindplay/annotations) [![Total Downloads](https://poser.pugx.org/mindplay/annotations/downloads.svg)](https://packagist.org/packages/mindplay/annotations) [![Latest Unstable Version](https://poser.pugx.org/mindplay/annotations/v/unstable.svg)](https://packagist.org/packages/mindplay/annotations) [![License](https://poser.pugx.org/mindplay/annotations/license.svg)](https://packagist.org/packages/mindplay/annotations)

Source-code annotations for PHP.

Copyright (C) 2011-2015 Rasmus Schultz 

https://github.com/php-annotations/php-annotations

For documentation and updates, please visit the project Wiki:

http://php-annotations.readthedocs.org/

## Project Structure

The files in this project are organized as follows:

```

php-annotations         This README and the LGPL license

  /src

    /annotations        The core of the library itself

      /standard         Standard library of annotation classes

  /demo                 Browser-based example/demonstration

  /docs                 Documentation files (http://php-annotations.readthedocs.org/en/latest/)

  /test                 Unit tests for the core of the library

    /test.php           Test suite runner

    /annotations        Fixture Annotation types

    /lib                Unit test library

    /runtime            Run-time cache folder used for tests

    /suite              Test cases

```

The "mindplay" folder is the only folder required for the annotation

framework itself - other folders contain demonstration code, tests, etc.

To run the test suite, run "php-annotations/test/test.php" from a

browser - a summary of the test-results will be displayed on the page.

## Code Style

Largely PSR-2 compliant:

https://raw.github.com/php-fig/fig-standards/master/accepted/PSR-2-coding-style-guide.md

## License

http://www.gnu.org/licenses/lgpl-3.0.txt

This program is free software; you can redistribute it and/or

modify it under the terms of the GNU General Public License as

published by the Free Software Foundation; either version 3 of

the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program; if not, see .

Additional permission under GNU GPL version 3 section 7

If you modify this Program, or any covered work, by linking or

combining it with php-annotations (or a modified version of that

library), containing parts covered by the terms of the LGPL, the

licensors of this Program grant you additional permission to convey

the resulting work.