---
title: PHP Coding Style 程式碼規範
tags: SOP, 專案, PHP
GA: UA-54884750-6
---

<!-- reference: https://hackmd.io/VMNXmnk4SBGktt9j4QhO_Q -->

# PHP Coding Style

[TOC]

# 基本原則

基本上遵照 PSR 提供的原則進行，我們目前採納以下原則，請先進行閱讀
- PSR-1: Basic Coding Standard
- [官方文件](https://www.php-fig.org/psr/psr-1/)
- PSR-4: Autoloader
- [官方文件](https://www.php-fig.org/psr/psr-4/)
- PSR-5: PHPDoc
- [官方文件](https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc.md)
- PSR-12: Extended Coding Style
- [官方文件](https://www.php-fig.org/psr/psr-12/)

# 延伸原則

- 基礎原則之上，延伸的是我們自己的一些規定。

## 檔案

### 最後空行

- 最後一行請留空行，並請只留一行

## Class

### 建構子/解構子放置位置

`__construct()` 放最上面，`__destruct()` 放最下面

## Function

### Return 前空行

- Return 前若有程式則需留下一行空行