skillup

技術ブログ

ドキュメント作成 プログラミング全般

ファジープロジェクト対策 その2

投稿日:

前回に引き続き、大事だと思ったこと。一部単なるフレームワークの作り方的な内容になっているかも。

テンプレート共通化

ラジオ、セレクト、チェックボックスなどはテンプレート化しておき、1行もしくは数行で処理がかけるようにしておくこと。

バリデーション

エラーのタイプを設定ファイルなどに定義しておき、できれば本来のロジックはほとんどいじらずにバリデーションチェックができるようにしておくこと

なおイレギュラーパターンに対応できるようにそうでないパターンにも対応できるようにしておくこと。

ログ出し

ログをまめに出す。もちろんレベル分けを行う。

具体的には下記のような段階

  • SQL(重要度で言うと最低、いわゆるdebugレベル)
  • 何らかの処理の開始と終了。処理のメモなど(infoレベル)
  • 望ましくないところ、あるいは異常系の処理(warn,またはerror)

異常系の処理

DBの前後は必ずtry〜catch・・で挟み異常処理が発生した場合に、rollbackできるようにしておくこと。

異常があった場合、

  • 全ての処理を終わらせるのか?
  • 特定の処理だけを終わらせるのか

をしっかりと分けること。

もちろんログの記録は単なるエラーではなくスタックトレース的なものがしっかりと吐かれていることが大切。

新規プラグイン+新規ライブラリ調査

もっとも時間がかかり、知識などで対応できないこともあるので厄介。

シンプルで最小構成のサンプルなどを用意しておき、試しておき、現在のアプリに対応できるようにすること。

CSSフレームワークの活用+頻出CSSについて

プログラム同様、フロントエンドでも頻出のCSS、関数などに関してあらかじめ定義しておき、一発で反映できるようにしておくこと。

個人的にCSSフレームワークはBulumaがおすすめ。

  • mobile時、pc時のみ表示できるCSS
  • テーブル
  • チェックボックス(ラジオ、セレクト)+ラベル
  • flexの組み合わせ(justify-content,align-itemsの組み合わせをあらかじめ作っておく)
  • 関数に関してはPC、SPをすぐに反映できるタイプのものにする。

-ドキュメント作成, プログラミング全般
-

執筆者:


comment

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

関連記事

no image

テストプロセスに関して

日々是テスト。 プログラマになってから数年がたちますが難点はずっと同じでテストですね(汗) 以前にかいたエントリーなどは下記参照。 参考 データベースによるテストデータ作成 Excelによるテストデー …

no image

オブジェクト指向 クラスの設計と業務ロジックの整理

本日も引き続き「現場で役立つシステム設計の原則」を読み進めてます。 本日は主にクラスの作り方について。 Contents1 クラス設計と業務ロジック1.1 要点1.2 感想 クラス設計と業務ロジック …

no image

オブジェクト指向設計 柔軟なインターフェイス

オブジェクト指向シリーズ。今回はインターフェイスについて。 インターフェイスといっても、implementsを使った実装だけではなく、要はあるクラスが外部の窓口となるときに使うメソッドってことだと思う …

no image

エラーレポーティングサービス Sentryについて

リリースした後、運用段階に入ると定期的にバグ報告が上がってきます。 本来はリリース前に研修テストをすべきなんですが、そんな余裕ないことも多い(汗) で、そんな時に大事なのが エラーを気づけること 対処 …

no image

コーディングルール 前半まとめ

リーダブルコードを3分の2ぐらいよんだので現時点でのまとめを。 Contents1 いいコードの定義2 具体的な手法2.1 変数の名称2.2 コード自体の見た目2.3 コメント2.4 制御フロー2.5 …