iT邦幫忙

第 12 屆 iThome 鐵人賽

DAY 12
2

其實阿宅 PO 一開始寫 JavaScript 是不知道 Coding Style 的
後來是因為開始需要跟團隊協作和寫使用手冊,才知道原來這個也有公訂規範
雖說有常用的幾個規範,但最後還是端看團隊需求為主唷~

使用 Coding Style 主要是為了以下兩點:

  1. 程式碼的易讀性
  2. 程式碼的可維護性

以下介紹之前團隊使用的 JavaScript Coding Style

命名規則

變數:小駝峰,有的團隊會再細分型態
函式:小駝峰,禁縮寫
類別:大駝峰,禁縮寫
常數:全大寫,多單字使用 _ 底線隔開

以上,簡單介紹我們團隊的命名規則
因為為了 易讀性,除了團隊內自己訂定的縮寫,大多命名會要求完整的單字,因為每個人對於縮寫的理解不同,所以要注意喲~

寫作風格

我們團隊使用的是 JavaScript Standard Style
搭配 ESLint 下去規範團隊成員的 Code

附上,官網 (繁體中文)
JavaScript Standard Style
讓大家參考一下


最近電腦爆炸,有些筆記都不見了...
分享的內容感覺不澎湃...Orz|||
希望各位捧油不要介意


上一篇
設計看文件 - 就從套件的文件開始吧!
下一篇
設計看JS - Parameter & Argument
系列文
前端設計轉前端工程師-JS踩坑雜記 30 天30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

1 則留言

0
ragnaok
iT邦新手 5 級 ‧ 2020-09-22 00:11:55

其實 ESLint 是的規則是變數要使用小駝峰來命名唷,而且變數是沒辦法使用 - 符號的唷
https://eslint.org/docs/rules/camelcase

已修正~
感謝大大的指正(合掌)
差一點就誤人子弟了...嗯湯

我要留言

立即登入留言