Coding Guide

  • 請使用英文/正體中文/中華民國/臺灣用語! 中文請使用全形符號!
  • Tab一律使用4個半形空格

HTML/CSS

  • 請使用flexbox,不使用float
  • CSS selector順序:
    1. element first
    2. .class second
    3. "#id" third
    4. @media query last
    5. each part order by first letter
  • 除上述外,HTML/CSS請參考Code Guide by @mdo

JavaScript

  • 除換新行外,逗號後方一律空格
  • 括弧與括弧內側程式碼不空格
  • 運算子(+ - / * > < || && == === …還有啥?)前後一律空格
  • 優先使用雙引號""
  • 請使用i++;
    不使用i += 1; 或i = i + 1;
  • 除上述外,依循其JSLint規則

運算式

  • 小括弧與外側程式碼空格
  • else換新行

      if (a == b) {  
          some code;  
          do {  
              other code;  
          } while (c > d);    
      }  
      else {  
          do something;  
      }  
    

Function

  • 與後方小括弧不空格,與大括弧空格
  • 左大括弧後、右大括弧前換新行
  • 請使用function funcName() {};
    不使用var funcName = function() {};

      function funcName(var1, var2) {
          some code;  
    
      // some comments
          other code;
      }
    

註解

  • 註解前一律空一行

HTML

  • 註解不縮排(即前面無空格)
  • 單行:
      <!--  comments in here  -->
    
  • 多行:
      <!--  comments in here,
        --  and here.
        -->
    

CSS

  • 縮排與下一行同步(CSS好像也不常超過2個Tab?XD)
  • 單行:
      /* comments in here */
    
    多行:
      /*  comments in here
       *  and here.
       */
    

JavaScript

  • 縮排較下一行少一個Tab(亦即較突出)
  • 若下一行無縮排,則不縮排
  • JSLint註解,依循其JSLint規則
      /*jslint white: true*/
      /*global $, alert, console*/
    
  • 單行:
      // comments in here
    
  • 多行:
      /*  comments in here
       *  and here.
       */
    

變數命名

  • 請盡量避免無異議名稱,如:var x, y; ...等

HTML/CSS多音節字

  • id、class使用-
  • name數值使用_

JavaScript多音節字

  • 變數使用小駝峰式命名
  • 資料使用_

這不是Coding,只是一些交代事項

  • v1網站的講座,每月15日爬一次資料,傳給暨南大學海外招生委員會Roger