はじめに
キャメルケースやケバブケースなど、コードを書くにあたって適切な書き方があるのはなんとなく知っていたが、認識としてある程度のルール化がされていることを知った。
それがPSR-12とのこと。
行の長さはどのくらいにしなければいけない、だったり
メソッド名の前に単一のアンダースコアをつけてはいけないなどルールが記されている。
https://www.php-fig.org/psr/psr-12/#44-methods-and-functions%EF%BC%89
こういうのがあるんだぞー。
というのを常に忘れないためにも備忘録として残す。
今回参考にした箇所
備忘録だったのでほぼほぼこの記事の役目は終了しましたが、今回実際に何をするために確認したのかも書いておく。
メソッドを書く場合どのケースで書くべきか
<?php
namespace Vendor\Package;
class ClassName
{
public function fooBarBaz($arg1, &$arg2, $arg3 = [])
{
// method body
}
}
- 一般的に小文字スタートで他の単語を繋ぐ場合は大文字をくっつけるキャメルケースが主流だが、その確認
- やはりメソッド名は公式でもキャメルケースで記載している
他参考になったこと
phpファイルの終了タグ
phpファイルだと認識をさせる<? php ?>だが、終了タグの?>は記載してもしなくてもどちらでも良いという認識だったのだが、公式を見ると終了?>タグを省略しなければなりません。とまで断言している。
行の長さ
行の長さに関して、厳格なルールはないが、原則として120文字でなければならないとのこと。
また行の長さに関しては、80文字より長くすべきではないとのこと。
インデント
コードは、インデント レベルごとに 4 つのスペースのインデントを使用しなければならず (MUST)、インデントにタブを使用してはなりません。とのこと。知らなかった。
まとめ
などなど知ってそうで知らないことまでたくさん書いてあるので、良いコードを書く上で必読だと思いました。
リーダブルコードなども併せて読んで、良いコードが書けるように努力していく。
以上