弊社で開発時に使う命名規則

2013年が始まりました。あけましておめでとうございます!今年も飛躍できるように精進します。
弊社の開発時のファイルや変数の命名規則や、ローカルのルールなんかを記載しておこうと思いました。

通常のファイル名
– 小文字とハイフンorアンダーバー
(アンダーバーは続き文字として認識され、ハイフンは区切った文字として認識されるらしい)

変数
– 小文字始まりのキャメルケース

定数
– 大文字で単語間をアンダーバーで区切る

関数名(function)
– 小文字始まりのキャメルケース

クラス名
– 大文字から始まるキャメルケース
– ファイル名:クラス名と同じ
– クラス内のメソッド:小文字から始まるキャメルケース
– クラス内のプロパティ:小文字から始まるキャメルケース (暗黙的なプライベート変数としてアンダーバーをつけるのは禁止)

DB関連
– テーブル名:小文字とアンダーバー
– フィールド名:小文字から始まるキャメルケース (主キーは「id」or テーブル名+Id「tableId」など)
– 全テーブルにregDateStamp, updateStamp, update, view, deleteFlgフィールドをつける

view: 規定値を1にする。そのレコードが有効なレコードで非表示にしたいときは0にする
deleteFlg: 規定値を0にする。そのレコードが削除された時に1にする。deleteFlgが1になったレコードは、DELETEクエリでいつ消されて問題無いという用途で使う
regDateStamp: レコード追加日時のunixタイムスタンプ
updateStamp: レコード更新日時のunixタイムスタンプ
update: レコード更新日時のY-m-d H:i:s

※既存の運営中のサイトは上記のルールになっていないことがあるので、その場合は既存のルールに従うようにします。

カテゴリー: 未分類

コメントを残す

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

*