cakePHPのコーディング規約


最近 cake で作ったアプリがリリ-スしたので、
リファクタリングというか
ちまちまとチューニングとかしています。

ついでに、必死こいてたせいで、目を通し忘れていた
コーディング規約とかに目がいったので、
そこも直してたりしますw
なんとなく翻訳気味に下記書いていきます。

*以下ここを参照しました。
cakePHP:コーディング規約

https://trac.cakephp.org/wiki/Developement/CodingStandards

インデント

One tab will be used for indentation.

1インデント=1タブってことですね。

制御文

In the control structures there should be 1 (one) space before the first parenthisis and 1 (one) space between the last parenthisis and the opening bracket.
Always use curly brackets in control structures, even if they are not needed. They increase the readability of the code, and they give you fewer logical errors.
Opening curly brackets should be placed on the same line as the control structure. Closing curly brackets should be placed on new lines, and they should have same indentation level as the control structure. The statement included in curly brackets should begin on a new line, and code contained within it should gain a new level of indentation.

制御文は半角スペース1個で区切っていきましょう。
あと大括弧は必ずつけましょうってことですね。

if (***) {

}

ってことです。
自分は半角スペース入れない人だったので、
修正が大変だったり。。。

メソッドコール

Functions should be called without space between function’s name and starting bracket. There should be one space between every parameter of a function call.

メソッドは メソッド名と() の間に半角スペースを入れないでコールしましょうってことですね。

As you can see above there should be one space on both sides of equals sign (=). To increase the redability of the code you can add spaces (or tabs) before the equals sign, but only in the case of a multiple function call presented below

代入とかで使う = の前後は半角スペースいれましょう。

メソッドの定義

Parameters with a default value, should be placed last in function definition. Try to make your functions return something, at least true or false – so it can be determined whether the function call was successful.

引数にデフォルト値があるやつは最後に入れましょう &
メソッドは必ず return でなんかかえしましょうってことですね。
引数の話は意味あるのかなぁ。見易さだけかな。

コメント

All comments should be written in English, and should in a clear way describe the commented block of code.

全てのコメントは英語で書きましょう。。(ロ)◎◎

インクルード

When including files with classes or libraries, use only and always the require_once function.

全部 require_once を使いましょう。

PHPタグ

Always use long tags:

全て <?php ?> を使いましょう
ここらへんはさすがに問題ないかな。

命名規則

・Function names should be written in camelBack
・Class names should be written in CamelCase

メソッドとクラスは camelBack で書きましょう

・Variable names should be as descriptive as possible, but also as short as possible. Normal variables should start with a lowercase letter, and should be written in camelBack? in case of multiple words. Variables containing objects should start with a capital letter, and in some way associate to the class the variable is an object of.

変数名はわかりやすくかつできるだけ短く。最初の文字は小文字で、かつ camelBack で。
オブジェクトの場合は最初の文字を大文字に。

なんか普通にやってるとここら辺は抑えてそう。

・A protected method or variable name start with a single underscore (“_”).
・A private method or variable name start with double underscore (“__”)

protected method はアンダースコア1個で
private method はアンダースコア2個で始めましょう。

private と protected の違いってなんだろう。。

ファイル系

File names should be created with lower case. If a file name consist of multiple words, they should be divided by an underscore character

ファイルは全部小文字で、あと区切り文字はアンダースコアで。
まあ apps_controller.php とか こんなんでいいってことですね。

定数

・Constants should be defined in capital letters
・If a constant name consists of multiple words, they should be separated by an underscore character

定数は全部大文字で。
あと複数文字がある場合はアンダースコアで区切りましょう。

ざっと見て、ほとんど大丈夫なんですが、
地味ーに半角スペースがとか微妙に camelback じゃないとか。

中途半端がいやなのでチマチマ修正してます。


Leave a Reply