PHPackages                             index0h/code-style - 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. [PSR & Standards](/categories/psr-standards)
4. /
5. index0h/code-style

ActiveLibrary[PSR & Standards](/categories/psr-standards)

index0h/code-style
==================

index0h code standard, based on PSR-2.

3861[6 issues](https://github.com/index0h/CodeStyle/issues)PHP

Since Sep 9Pushed 11y ago2 watchersCompare

[ Source](https://github.com/index0h/CodeStyle)[ Packagist](https://packagist.org/packages/index0h/code-style)[ RSS](/packages/index0h-code-style/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

CodeStyle 0.0.1
===============

[](#codestyle-001)

Что такое CodeStyle?
--------------------

[](#что-такое-codestyle)

**CodeStyle** - это набор валидаторов кода на базе **[PHP\_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer)**. Есть полная совместимость с **[PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)**.

Установка и выполнение.
-----------------------

[](#установка-и-выполнение)

### Через [Composer](http://getcomposer.org/download/).

[](#через-composer)

В тег **require**, или **require-dev** необходимо добавить:

```
{
    "require": {
        "index0h/CodeStyle": "dev-master"
    }
}
```

Дальше необходимо применить обновления с тегом **--dev** если пакет был добвлен в **require-dev**.

```
composer.phar update
```

Выполнение проверки вашего проекта.

```
vendor/bin/CodeStyle.sh
```

### Через [git](http://githowto.com/ru), или скачав [архив](https://github.com/index0h/CodeStyle/archive/master.zip).

[](#через-git-или-скачав-архив)

Этот случай предполагает, что [PHP\_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) устанавливается отдельно.

```
git clone https://github.com/index0h/CodeStyle.git
```

Выполнение.

```
phpcs --standard="/path/to/CodeStyle/CodeStyle" /path/to/my/project/
```

Описание отличий **CodeStyle** от [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)
------------------------------------------------------------------------------------------------------------------------------------

[](#описание-отличий-codestyle-от-psr-2)

Файлы.
------

[](#файлы)

- В **одном** файле может находится только **один** класс, или только **один** интерфейс.
- Файл должен содержать **комментарии** в заголовке в [phpdoc](http://www.phpdoc.org/) формате.
- После комментария файла должен быть **перевод строки**.
- Комментарий файла должен начинаться на **новой строке** после **<?php**.
- Комментарий файла должен содержать **краткое описание**, после которого должна быть **пустая строка комментария**.
- Комментарий файла должен содержать теги **category**, **package**, **subpackage**, **author**, **copyright**, **license**, **link** в данном порядке.
- Значения тегов в комметарии файла должны быть **выровнены**.
- Пустые строки в комментарии файла **запрещены** всюду, кроме после **короткого** и **полного** комментария.
- Префикс комментария файла должыен быть: **\[пробел\]\*\[пробел\]**.

```