PHP Standard code ของฉันเอง

บทความนี้เขียนเพื่อเป็นมาตรฐานในการเขียนโค้ดภายในทีมเท่านั้น อาจไม่ถูกต้องตามมาตรฐานทั่วๆ

ตั้งชื่อ

ชื่อคลาส StudlyCase

class MyClassController

ชื่อไฟล์ ชื่อ folder

MyClassController
Models/MyClassModel.php

ชื่อ method/function ใช้ camelCase

function myMethod

ชื่อตัวแปรใช้ under_score

$account_id = 'foo';
$social_api = 'bar';

ชื่อ URL ใช้ lower-dash

http://localhost/api/v2.5/user-album
http://localhost/user-register

ชื่อ const ใช้ UPPER_UNDERSCORE

const PARAM_1 = "root"

ใช้ true, false, null ตัวเล็ก

$foo = true;
$bar = false;
$foo_bar = null;

ช่องว่าง และ บรรทัด

tab ใช้ 2 space

function myMethod()
{
$a;
$b;
$c;
}

class/method/function ปีกกาบรรทัดต่อไป

class MyClassController
{
  function myFunction()
{
// code
}
}

function inline, if, else, switch, while, for ใช้ปีกกาบรรทัดเดียวกัน เว้น 1 ช่อง

if ($foo == null) {
// code
}

หลัง comma เว้น 1

function myFunction($param1, $param2, $param3)

ก่อน/หลัง =><!=เว้น 1

if ($foo == null)
$foo = 'bar';

หลายบรรทัด

$array = [
'array1' => 1,
'array2' => 2,
'array3' => 3
];
$class = new MyClassName([
'setting1' => '1',
'setting2' => '2',
'setting_setting' => '3'
]);

class/method/function เว้น 1 บรรทัด

class MyClassName {
  public function()
{
// code
}
}

Comment

// comment
$foo = null
/*
comment
*/

การ comment function

/**
* description
*
* @param int param_name
* @param type param_name
* @return type
*/
funciton myFunction()
{
// code
}

อื่นๆ

php tag ใช้ <?php ?> สำหรับ code

<?php
//code
?>

หากไฟล์เป็น php ล้วน ไม่ต้องมี tag ปิด เพื่อป้องกัน white space

<?php
//code

สำหรับ echo

<?= $foo ?>

TODO ใช้สำหรับ note เอาไว้ว่าจะทำ (เวลาจะมาทำต่อก็แค่ค้นหาคำว่า TODO:)

// TODO: description
Like what you read? Give dagdun a round of applause.

From a quick cheer to a standing ovation, clap to show how much you enjoyed this story.