まぐねっと的プログラミングポリシー

イシュー

  • 今、内部設計書という名のプログラム設計書を書いている。
  • やっていることは、プログラムを日本語で書くこと。Excelにプログラムを書いている気分である。
  • 行き当たりばったりで書くのはイヤなので、プログラミングポリシーとしてガイドラインを設定しておく

プログラミング設計書記載ポリシー

  • メソッド呼び出し先の処理の開始は、パラメータ(リクエスト、関数の引数)の取得から始まる
  • 項目のバリデーションは、サブミット直前に行なう
  • nullチェックなどのバリデーションは代入直前に行なう(lazy valを想定)
    • でも nullチェックの処理は日本語では書かない(設計の本質ではない)
  • 基本的にメソッド呼び出しとマップ処理のみを書く。
    • マップのパターン=(変数名←代入値)
    • SQLからHTMLにマップする例
      • SELECT項目名(SQLという名のメソッド
      • JSON項目名 ← SELECT 項目名(マップ)
      • HTML項目名 ← JSON 項目名(マップ)
  • マップは、「定義名(変数名)、項目名(意味)、処理内容(値を変数へ代入)、値」の順番で記載
    • 主語、述語、目的語の要領

参考