Doctrine Coding Standard 使用教程

Doctrine Coding Standard 使用教程

coding-standardThe coding standard of the Doctrine project.项目地址:https://gitcode.com/gh_mirrors/codi/coding-standard

1、项目的目录结构及介绍

doctrine/coding-standard/
├── .github/
│   └── workflows/
│       └── ci.yml
├── bin/
│   └── phpcs
├── phpcs.xml.dist
├── composer.json
├── LICENSE
├── README.md
└── src/
    └── CodingStandard/
        ├── Doctrine/
        │   ├── AbstractDoctrineSniff.php
        │   ├── Commenting/
        │   ├── ControlStructures/
        │   ├── Functions/
        │   ├── Import/
        │   ├── NamingConventions/
        │   ├── PHP/
        │   ├── Strings/
        │   ├── Whitespace/
        │   └── ruleset.xml
        └── ruleset.xml

• .github/workflows/: 包含GitHub Actions的CI配置文件。
• bin/: 包含可执行文件，如phpcs。
• phpcs.xml.dist: 项目的默认PHPCS配置文件。
• composer.json: Composer依赖管理文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• src/CodingStandard/Doctrine/: 包含Doctrine编码标准的具体实现。

2、项目的启动文件介绍

项目的启动文件主要是bin/phpcs，这是一个可执行脚本，用于启动PHP CodeSniffer工具并应用Doctrine编码标准。

3、项目的配置文件介绍

项目的配置文件主要是phpcs.xml.dist，这是一个PHPCS配置文件，定义了项目的编码标准和规则集。以下是该文件的部分内容示例：

<?xml version="1.0"?>
<ruleset name="Doctrine">
    <description>The Doctrine Coding Standard is a set of PHPCS rules applied to all Doctrine projects.</description>

    <rule ref="Doctrine"/>

    <!-- Add custom rules here -->
</ruleset>

该文件定义了项目的名称、描述以及应用的规则集。开发者可以根据需要在此文件中添加自定义规则。

coding-standardThe coding standard of the Doctrine project.项目地址:https://gitcode.com/gh_mirrors/codi/coding-standard