JavaScript

Javascript suggestion(提案)

関数の定義の仕方: 役割をひとつに絞る

依存性が高い:

  function appendElRightArrow() {
    var el;
    el = document.createElement('div');
    el.setAttribute('class', 'arrow-right');
    document.querySelectorAll('selector to be appended')[0].appendChild(el);
  }

依存性が高い理由: selector to be appendedが変わると関数内部を修正する必要がある。

依存性が低い:

  function getElRightArrow() {
    var el;
    el = document.createElement('div');
    el.setAttribute('class', 'arrow-right');
    return el;
  }

命名規則

  • 変数: 名詞 (例外: 'is'で始まるものは除く)
  • 関数: 動詞

変数:

  • 赤い要素: red element
  • 挿入される要素: element to be inserted
  • Aを走らせる要素: element which make A run.
  • 背景が青い要素: element that background is blue.
  1. 形容詞を用いる: サフィックスになる
  2. 関係代名詞等を用いる: プレフィックスになる

プログラムでは2の関係代名詞等をよく使うので
プレフィックスがいいのかなと個人的に思ってる( ¨̮ )

まとめ
- 関数, メソッド名は必ず動詞でつける
- 型をprefixとしてつける。例:
    - jQuery object: $phone
    - element: elPhone
        - 説明: 値がDOMObject -> 変数に'el'というプレフィックスをつける   例: elToDisplayDate
          - 理由: セレクター(文字列)やその他変数などとの判別のため
    - string: strPhone
    - int: iPhone