*

php:関数の命名について

公開日: : php


DBに登録されている日時と現在日付から5日前である事をチェックする関数名で

下記で一番わかりやすのはどれでしょうか?

・hogehoge

・checkDateBefor5Days

・tanaka_max

 

checkDateBefor5Daysを選んでくれるはずです。

 

名前をつける場合は

・何をしている関数なのか

・再度読み返す際にわかりやすくするのが重要で、

今回は2番目を実現するために重要なことを記載しませう

 

それが、コーディング規約です。

 

共通のルールに則って関数の命名、

記載の方法を取る事で、

 

これだけで、開発、保守性が格段に向上します。

 

checkDateBefor5Days

camelCapsというルールに従い

何をするか、

何に対して

と記載していっています。

 

たったこれだけですが特定の規約に則っている事が重要です

それにより、どのように読めばいいのか確認しやすくしているのです。

 

複数人数が同じ規約で運用する事が大事な事なので、

どのような規約を策定してもいいのですが、

 

もしあなたのチームに関数の命名ルールが無く

今後ルールを策定したいのならば、

zendコーディング規約等を持ち込んでみてはいかがでしょうか?

 

phpにてサービスを運用しているチームであるならば、

zendという単語を聞いた方が多いでしょうし、

比較的すんなりと受け入れられるかもしれませんよ

 

また、一般的なフレームワークを利用しているプロジェクトである場合は、

既にフレームワークにて規約が策定されているはずなので、

そのまま学習を進めれば自然と身につくと思いますので、

フレームワークでの規約にしたがうのがいいと思います。

 

 

 

蛇足

 

『俺がわかればいいんだよ』

『どれにしたってちゃんと動いてるから大丈夫』

 

以前の会社の先輩にいたんです、こういう方が…

そういう方に限って、自分で何をしたのかを忘れて

しれっと『コレなんだ』って聞いてくるので(゚Д゚)ハァ?っとなったものです。

 

ad_right_top

関連記事

blog_logo_small

php:バージョンの確認方法

インストールされているphpのバージョンを確認する方法です。   コマンドで確認す

記事を読む

blog_logo_small

phpフレームワーク — Laravelのご紹介

webサービスの構築をおこなうにあたり、どのような言語/ミドルウェアを利用するかは作成するサービスの

記事を読む

blog_logo_small

php:GD画像ライブラリのインストール

MediaWikiを利用する上で、画像のサムネイル表示を使う場合はインストールが必要となります。

記事を読む

blog_logo_small

php:配列の要素を連結して文字列出力[implode]

ログ出力などで配列の中身を出力したい場合に、簡単に配列を連結して文字列化する方法です。 &nb

記事を読む

blog_logo_small

intl PEC のインストール

MediaWikiの利用において「intl pecl 拡張機能」を使用する場合はインストールが必要で

記事を読む

blog_logo_small

php:文字列内で対象が現れる場所を見つける[strpos]など

文字列内の部分文字列検索。用途に合わせて色々と関数が用意されているので記憶の片隅に置いておくと良いか

記事を読む

blog_logo_small

php:文字列分割関数explodeとpreg_splitの速度について

以前の記事で文字列分割を行うexplodeとpreg_splitを紹介した際に、explodeの方が

記事を読む

blog_logo_small

php:配列でキーの存在確認をする方法

ソースを書いていて何度が調べることがあったので備忘の為に残しておきます。   配列

記事を読む

blog_logo_small

php:for文の終了条件には複雑な処理を書かない

php で for文を使ってループ処理をするときの注意書きです。 for文の構造は下記のような

記事を読む

blog_logo_small

Laravel:artisanを利用したコマンドライン実行

定期的にデータの更新が必要な場合などにphpで記述した処理を実行したい時もあるかと思います。メンテナ

記事を読む

google以外広告

Message

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

次のHTML タグと属性が使えます: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>

ad_right_top

linux-pen
【cron】秒間隔で定期実行する為の設定方法

コマンドを定期実行させたい場合に利用するcronですが、普通に利用する

blog_logo_small
【Apache】 ReverseProxy(リバースプロキシ)を設定してサブディレクトで別サーバーの内容を表示

今回はApacheのリバースプロキシ設定について紹介したいと思います。

blog_logo_small
【Apache】 Aliasを設定してサブディレクトでDocumentRoot以外を参照する

今回はApacheのAlias設定について紹介したいと思います。この方

no image
2015:新年のご挨拶

明けましておめでとうございます。 昨年はたくさんの方々に当ブログ

blog_logo_small
MySQL:外部ホストからのDBアクセス方法

MySQLではデフォルトで外部ホストからのアクセスを許可していないので

→もっと見る

  • アクセスカウンター
PAGE TOP ↑