Hapicode

# 開発におけるコーディングルール・規約

すべての開発において、ソースコードがスパゲッティ化にならないように気をつけるべきこと

  1. include 変数宣言は function の最初に行う
  2. Function の上にコメントで説明入れる
  3. グローバル変数できるだけ作らない
  4. 単一目的変数使う
  5. 肥大化しないように Block 外だしする
  6. 入れ子の階層は２階層まで

コーディングの速さ、メンテナンスのしやすさ、後継ぎのことを考えながらコーディングするのがプロである

# BASE

  • VSCode 使う
  • コードフォーマットは Prettier - Code formatter (opens new window) 使う
  • マジックナンバー使わないで定数明確化
  • 型のキャストは小文字
  • 文末の空白を除去
  • シングルクォートとダブルクォートは適切に使い分け

# 共有連絡必要な項目

  • 共通類：migration 追加・変更・削除
  • 設定類：設定変更、追加する必要がある env config など
  • コマンド類：コマンド実行する必要がある場合
  • 他のメンバーに影響する箇所がある場合
  • コードの読みやすさは賢さや短さより重要

# コーディング

  • インデントスタイルはスペース 4 つ
  • controller から model 直接引用しない、repository に集約管理
  • 定数はすべて大文字で、アンダースコア
  • すべてのブロックに対してブレース (波かっこ) を使用
  • elseifを使うelse ifは禁止
  • PHP ショートタグは禁止
  • 変数、アクションの名前は小文字でスネークケース使用

プレース使わない悪い例




 









 

  $i = 0;
  $k = 1;

  if( $i === 0 ):

  /*
   * 長い処理....
   */

    if( $k > $i ){
        echo $k;
    }

  endif;

# テーブル命名規則

  • テーブル名 小文字スネークケース
  • カラム名 小文字スネークケース

# 変数、定数、Payload Request Parameter の命名規則

  • できるだけテーブルカラム名に合わせる
  • 一時変数除いて３文字以内は非推奨
  • クラス名はパスカルケース MyControllerClass
  • PHP 変数名はスネークケース
  • JS 変数名はキャメルケース
  • 定数は全て大文字のスネークケース

# インデント

# DB マイグレーション

  • 不要なテーブルは名前の末尾にアンダーバーつけて時間置いて削除
  • テーブル構造はすべてマイグレーション化する

# コメントを大事にする

  • ファンクション毎にコメントで説明する
  • 重要箇所はコメント
  • 不安定箇所や今後変更される予定のある箇所は TODO つける

# ドキュメント残す

プロジェクトの規模にもよりますが、できればドキュメントをまとめてドキュメントサイトに管理した方がいい。

  • 検索機能
  • git 管理で変更履歴確認
  • ハイライト
  • 見出し

# エディター設定

.editorconfig

## EditorConfig is awesome: https://EditorConfig.org

## top-most EditorConfig file
root = true

## Unix-style newlines with a newline ending every file
[*]
end_of_line = lf
insert_final_newline = true

## Matches multiple files with brace expansion notation
## Set default charset
[*.{js,php}]
charset = utf-8

## 4 space indentation
[*.php]
indent_style = space
indent_size = 4

## Tab indentation (no size specified)
[Makefile]
indent_style = tab

## Indentation override for all JS under lib directory
[lib/**.js]
indent_style = space
indent_size = 2

## Matches the exact files either package.json or .travis.yml
[{package.json,.travis.yml}]
indent_style = space
indent_size = 2

# キャメルケース スネークケース　ケバブケース　パスカルケース　命名規則

ケース名 例 説明 よく使うパターン
キャメルケース camelCase 先頭小文字、接続要素語先頭大文字にする命名規則 PHP JS などの関数名
パスカルケース PascalCase 先頭大文字、接続要素語先頭大文字にする命名規則 PHP JS などの関数名
スネークケース snake_case アンダーバーで要素語をつなぐ命名規則 DB カラム名、PHP 変数名
ケバブケース kebab-case ハイフンで要素語をつなぐ命名規則 ファイル名、HTML の class 名
  • キャメルケースはローワーキャメルケースともいいます
  • パスカルケースはアッパーキャメルケースともいいます。

言語ごとの命名規則

# Git ブランチ管理

ブランチ名

  • 開発環境 develop
  • 検証環境 staging
  • 本番環境 main
  • 課題があれば課題番号でブランチ切る

# .env ファイル

  • 環境変数追加した場合、.env.example に Key を追加
  • Key 追加後情報共有
  • 本番環境にリリースする前に開発環境、ローカル環境の.env差分確認
2019-06-01
  • php
  • javascript
  • 開発ルール

関連記事

Code review コードレビューの自分なりの考え

コードレビューの必要性について、チーム開発においてメンバースキルの向上、全体開発スタイルの統一などい...

JavaScript ライブラリ aos.js 使ってスクロール連動アニメーション

aos.js ライブラリ使ってHTML要素がスクロールと連動してアニメーションをします。...

大きいファイルをスライス分割してアップロード

大きいファイルを分割アップロードする方法、並行処理と失敗した際の自動アップロードします。...

Nuxt.js と Ant Design Vue 2 テーマカスタマイズ

Nuxt.jsとAnt Design Vue 2を使用してテーマカスタマイズしてみました。...

Javascript 非同期処理 async と await のメモ

javascript async await 使って非同期処理のいろいろ...

bootstrap vuejs 使って generate する際に babel が icons ファイル max 500KB エラー
Cookie localStorage sessionStorage の違い

Cookie とWeb Storage localStorage sessionStorageの違い...

javascript 楽しく遊ぼう!メッセージつぶやくウシ cowsay

楽しくjavascriptを遊ぶ用のパッケージcowsayについてのメモ...

javascript 日本語 shift-js 対応 CSV ダウンロード

javascript shift-jsエンコード CSVダウンロードが必要になったので、作ってみまし...

Javascript DataTables で excel 風 table 作る

JQueryでエクセル風テーブルの一部だけ横スクロールできるようにDataTables使ってみました...

javascript 配列 重複排除

javascriptで配列重複排除の複数やり方をまとめ、よく使うfilterとEcmaScript ...

もっと Docker 使おうよ！Node を Docker から引っ張ろうよ

Node.jsのバージョン管理をNVMではなく、Dockerから引っ張るように遊んでみました。...

ブラウザーで動く javascript のクッキー操作ライブラリ js-cookie

フロントのブラウザー側で動くjs cookieについて...

国際化 i18n と地域化 L10N

i18n が internationalization の略で国際化という意味で、地域化は L10n...

javascript 文字列と配列検索 indexOf findIndex find some includes 関数の違い

よく使う文字列と配列検索関数比較 javascript 文字列と配列検索 indexOf findI...

キーコード取得 ＆ キーコード一覧

javascriptで Tabキー 無効化をする仕事があり、キーコードの一覧を備忘録的にメモ...

Jsconfig と Tsconfig

javascriptで開発する際に使うjsconfigとtsconfigのjsonファイルとはなにか...

ReferenceError: location is not defined

ssrレンダリングする時に出る location is not defined エラー##...

moment.js 使って日本語曜日対応

momentjsの日本語表示、曜日の日本語表示と略称表示について...

nodejs 使う時のエラーたち

node学習しながらエラーの原因などを調べてメモります。...

Nuxtjs 動的なルーティング静的ページ自動生成

Nuxtjs 動的なルーティング使ってAPIとJSONで静的ページ一括生成してSEO対策...

vuejs で omisejapan の決済フォーム作成した時のメモ

フロント開発 omisejapan カードペイメント vuejs でフォーム開発する時のメモ...

javascript で作る html から PDF 変換 pdfmake の日本語対応

html pdf 変換する際に使っていたjavascriptライブラリpdfmakについて調べたこと...

javascript password generator ランダム文字列パスワード作成

javascriptで大文字・小文字・数字・記号対応のランダムパスワードつくることがありますが、vu...

Javascript 電話番号フォーマット

固定電話 携帯電話 フリーダイヤルなどの電話番号をハイフォン入で自動フォーマットしてくれるjavas...

react 強制的にレンダリングする方法

React使って値は変更されるけど、画面描写されないトラブルの対応方法...

javascript reduce 連想配列の合計計算覚えよう

javascript 配列 sum 合計計算、reduce 使ってやってみて覚える連想配列の落とし穴...

正規表現一覧 よく使う検索・置換のパターン

よく使う正規表現、文字検索・置換をまとめてみました。...

Sweet Alert swal に複数 content

javascriptアラートを綺麗に表示する粋なライブラリSweetAlertのswalの中のcon...

javascript 　指定場所にスムーズにスクロールする方法

クリックして指定のアンカーにスクロールするjavascript作成しました。scrollToとscr...

Javascript vuejs の validation 正規表現でフォームチェック作ったときのメモ

電話番号チェック・メールアドレスチェック・文字チェック・郵便番号のチェックに使えるjavascrip...

javascript 開発で出会った TypeError

vuepress で Cannot read property 0 of undefinedのタイプ...

vuejs back to top button component 作成

vue でトップに戻るボタンを作ることがよくありますが、ライブラリー使わずに実現してみました。...

Javascript var let const 変数宣言の違い

javascript varとlet 違い これからはvarよりlet constを書くようにすべき...

Carbon で php date 日付の日数・月数差を計算

Laravel Carbonは、DateTimeクラスよりもシンプルで読みやすいコードを書くことがで...

nuxtjs と codeigniter で jwt システム構築

nuxtjsとcodeigniterでシステム構築する際のメモ...

Apache 初期設定メモ

LAMP環境のApache初期設定メモ...

Codeigniter APPPATH BASEPATH FCPATH 各種パスと URL 取得

codeigniter host url取得方法と APPPATH BASEPATHの意味を紹介...

Codeigniter 画像アップロードとリサイズ

Codeigniter アップロード画像リサイズと回転するなど画像操作するライブラリの使い方...

爆速軽量フレームワーク codeigniter PHP 開発

ルーター設定もなく、初期設定も少ない！軽量と爆速で動いてくれるフレームワーク codeigniter...

Composer コマンドとオプション

composer install updateの違い post-install-cmdとpost-u...

codeigniter email ライブラリでメール送信 日本語対応

codeigniterメール送信で日本語文字化け対策、改行コードとSMTP項目設定...

php CSV データ取得は fgetcsv 使う

PHP csvアップロードしてデータインポート作業がありましたが、fgetcsv使ってcsv処理につ...

php curl 使って クリックなしで POST 送信

PHP curl_setopt使ってシンプルにデータ転送してpost投げます。PHPは本当に短いソー...

PHP empty isset is_null の違い

PHP empty, isset, is_nullの違い よく使うPHP isset と if の違...

PHP mbconvertkana 全角半角英数カナ変換

php カナコンバートなら mb_convert_kana を使う！全角半角、英数字や記号など簡単に...

FlattenException deprecated

laravelバージョンアップ作業する際にFlattenException deprecatedにつ...

allowurlinclude の設定で ftp_connect()エラー

FTPサーバーとやりとりする時にftp_connect()エラーが発生、PHP７にアップしたばかりで...

php Exception エラーキャッチでメール送信

エラーメッセージ、エラーコード、エラー詳細取得、php例外処理exceptionのいろいろ...

Class 'Imagick' not found Error

phpで画像操作したらimagickエラーで動かなくなったため、imagickモジュールをインストを...

Laravel blade foreach loop と current url

laravel blade foreach loop変数とurlのプロパティ対照表...

Laravel eloquent model の規約

最新Laravel開発eloquent model設定資料まとめ...

Laravel でカテゴリー作成 テーブル構築と再帰クエリ

カテゴリ関係を管理するためのテーブルを設計...

Laravel Email バリデーションについて

Laravel Validation Email チェックする際の注意点、バリデーションルールオプシ...

Laravel Error についてのメモ

laravelを使う時に出てくるエラー対応...

Laravel Log の基本設定＆使い方

Laravel Logの基本設定 エラー発生時にslackに連絡通知する設定方法 tailコマンド使...

Laravel Lumen Faker 日本語設定

Laravel Faker 日本語化設定 fakerphpの使い方とよく使うオプション 名前や住所の...

Laravel logger でエラーログを chatwork に自動送信

Laravel 使ってエラー発生した場合、chatworkにエラー内容をリアルタイムで連絡するcha...

Lumen と Laravel 違い比較

軽量で速いマイクロフレームワークlumenとlaravelの違い、使い方比較と本当にlumen必要か...

Laravel メンテナンスモード

Laravelのメンテナンスモードの使い方 Artisan down コマンド使ってメンテナンスモー...

laravel method の基本 get post put options

Laravel Routeでget post メソッド同時に設定したい！Laravel ルート制約の...

Laravel を API サーバーとしての初期設定

Laravel インストールからローカル環境のSail docker開発、初期設定までプロジェクト構...

Laravel リクエストログ出力

Laravelでリクエストログを出力する手順をまとめました。...

Laravel Sail で Docker 環境構築

Laravel Sail で Docker 開発環境PHP Mysql phpMyAdmin構築 s...

Laravel Sanctum 使って API トークン JWT 認証と SPA 認証

Laravel JWT APIトークンの仕組みと Laravel Sanctum SPA認証使って認...

laravel session を制する

laravel sesssion 使い方を紹介、読込保存削除を使えるようになったらsession制覇...

Laravel Test についてのメモ

Laravel自動テスト行う際のコマンドと設定 faker 使ってデータ生成...

Laravel schedule 設定

Laravel スケジュール管理の基本とtimezone設定などlaravel 8最新メソッド説明...

Laravel timestamp() auto update 有効化無効化

Laravel updated_at timestamp自動にしたい！MysqlはすぐにできるけどS...

Laravel tinker 使って DB データベース接続とコマンド

Laravel tinker REPLツール使ってDBアクセス、環境確認など対話式で楽しく遊べる...

Laravel toSql パラメータ付きで出力

Laravel Query Builder toSqlで出力したsql文にパラメータを自動でセット...

Laravel 5.1 から 8.1 にバージョンアップ

laravel5 から8にアップグレードする際に遭遇したエラーとカスタマイズauth認証の設定を修正...

Laravel 429 Too Many Requests

Laravel 19使ってAPIサーバー構築とフロントはReact nextjsで構築しています。複...

laravel に vuejs 使うための初期設定

PHPフレームワークlaravelにvuejs入れる時の初期設定まとめ、備忘録的...

Lumen8 で JWT ユーザー認証

Lumen8でJWT認証のAPIサーバー構築してみた、便利になった時代だなあ...

Lumen8 で API 開発

codeigniter 愛用者がLumenでAPIサーバーを立ててみた...

PHP 7.4 にアップグレードして使えなくなる機能

php 5 から php7.4 にアップする作業があったので、アップグレード時のエラーと7.4では動...

HTML から PDF に変換 PHP ライブラリ mPDF の設定

HTMLレンダリングしてPDFに変換出力するライブリmpdfを使いこなせるための設定いろいろ...

PHP 8 リリース新機能と変更

php8がリリースされたので、新機能と特徴などの資料まとめました。25周年迎えたPHPは更に速いプロ...

PHP 8.1 から 8.4 へアップグレードしました

UbuntuでPHP 8.1から8.4にアップグレードする方法を説明します。...

php.ini 初期設定のいろいろ

php ini ローカル環境や新規リモート環境の初期設定...

Smarty HTTP URL 取得できるサーバー関数

スマーティで取得するサーバー関数URLとenvなど...

解決！phpMyAdmin テーブル構造の内容が表示されない問題

phpmyadmin5.0.1のxampp入れたら テーブル構造メニューが真っ白になって表示されない...

PHP 文字列長さ・文字列の幅を取得方法

PHP 文字列操作関数 マルチバイト文字列日本語韓国語中国語の長さ取得など...

twig 3 人気 PHP テンプレートエンジンがバージョンアップ

以前からtwigテンプレートエンジン使っていて、非常にパワーフルで使いやすさに魅了しました。15日に...

開発時によく使うゼロ埋めパディング作業まとめ

mysql twig phpとjavascriptでよく使うゼロ埋めのいろいろ...

Exception: Class 'ZipArchive' not found

エクセル操作でZipArchive classが見つからないエラーがあったので、対応しました。...