iT邦幫忙

第 11 屆 iT 邦幫忙鐵人賽

DAY 16
2

javascript 怎麼下個好註解? ESLint airbnb 規則
今天來介紹 ESLint airbnb 中對於註解的建議,好的註解除了可以增加程式碼的可讀性之外,對於團隊間的開發,如果有培養下註解的默契,在維護上也會有幫助歐!以下就針對 airbnb 中跟註解相關的規則一一示範唄!


18.1 多行註解使用 /** ... */ ,包含描述,指定類型以及參數值還有回傳值

不好的寫法:

// make() 根據傳入的 name 名稱回傳一個新的元件
//
// @param {String} name
// @return {Element} element
function make(name) {
  
  // ...stuff...
  
  return element;
}

好的寫法:

/**
 * make() 根據傳入的 name 名稱回傳一個新的元件
 *
 * @param {String} name
 * @return {Element} element
 */
function make(name) {

  // ...stuff...

  return element;
}

18.2 單行註解使用 //

在要註解的程式碼上方進行註解(不要在後面)

不好的寫法:

const cute = '江小姐';  // 這倒是真的

好的寫法:

// 這倒是真的
const cute = '江小姐';

在註解的上方空一行,除非他在區塊的第一行

在註解的上方空一行:

function speak() {
  console.log('我只是要來卡個位');

  // 設定預設文字 '我想一下'
  const event = goodNews || '我想一下';
  
  return event;
}

如果在區塊第一行就不用空一行:

function speak() {
  // 設定預設文字 '我想一下'
  const event = goodNews || '我想一下';
  
  return event;
}

18.3 在註解前方加上 FIXMETODO 可以幫助其他開發人員快速瞭解這是一個需要重新討論的問題

18.4 使用 // FIXME 說明哪裡出了問題:

function february() {
  let mon = `二月`;
  
  // FIXME: 哪來的32天啦
  let days = 32;
  console.log(`${mon}有${days}天`);
};

18.5 使用 // TODO 說明問題的解決方式:

function february() {
  let mon = `二月`;
  
  // TODO: 抱歉我手殘,改好了
  let days = 28;
  console.log(`${mon}有${days}天`);
};

以上就是關於 airbnb 註解規則的簡單介紹&範例,給各位參考參考嚕!


上一篇
Day15【ES6 小筆記】物件縮寫好棒棒!Object literal extension
下一篇
Day17【ES6 小筆記】Array.reduce() - 陣列累加 / 比大小 妙招
系列文
透過 ESLint 練習 JavaScript ES630

2 則留言

0
來杯拿鐵
iT邦新手 3 級 ‧ 2019-09-17 22:08:02

很有幫助

謝謝!!

0
阿展展展
iT邦好手 1 級 ‧ 2019-10-13 13:10:12
// 這倒是真的

/images/emoticon/emoticon01.gif

我要留言

立即登入留言