baserCMS Documentation

Githubでこのページを編集

Home / 5 / ucmitz / regulation / コーディング規約

コーディング規約

基本的には、 PSR-12 coding style guide および、 CakePHP コーディング規約 - 4.x に従って頂くものとし、下記のルールにも従います。

プログラムコードのヘッダー

各ファイルの最上位に記述します。

/**
 * baserCMS :  Based Website Development Project <https://basercms.net>
 * Copyright (c) NPO baser foundation <https://baserfoundation.org/>
 *
 * @copyright     Copyright (c) NPO baser foundation
 * @link          https://basercms.net baserCMS Project
 * @since         5.0.0
 * @license       http://basercms.net/license/index.html MIT License
 */

 

クラスヘッダー

クラスの先頭にはクラスヘッダーをつけます。

/**
 * Class SitesController
 */
class SitesController extends BcAdminAppController {}

 

メソッドヘッダー

メソッドの先頭にはメソッドヘッダーをつけます。

 

/**
 * サイト一覧を表示する
 * 
 * @param SiteManageServiceInterface $siteManage
 * @checked
 * @noTodo
 * @unitTest
 */
public function index(SiteManageServiceInterface $siteManage){}

 

メソッド間

メソッドとメソッドの間では1行の空行を入れます。

 

メソッド名

ロウワーキャメルケースとします。

 

プロパティ名と変数名

オブジェクトのプロパティ名のみ、アッパーキャメルケースとし、その他の変数は全てロウワーキャメルケースとします。

class UsersController extends AppController 
{
    public $Users;
    private $user;
    protected function getStatus()
    {
        $user = $this->Users->find()->first();
        return $user->status;
    } 
}