JavaScript >> Javascript 文檔 >  >> JavaScript

如何在 JavaScript 中使用註釋

這篇短文將解釋在 JavaScript 中應該如何以及為什麼使用註釋。

首先,如何評論。

什麼是評論?

一個評論 in programming 是一行或多行不被解釋為編程指令的文本。相反,計算機在執行您的代碼時會跳過它們,完全忽略它們。因此,註釋不必符合任何有效的語法。 它們只是你閱讀的文本,而計算機沒有。

JavaScript 中的單行註釋

評論很容易。 有多容易? 這很簡單:

// This is a comment

任何以 // 開頭的行 (雙斜杠)是註釋。

JavaScript 中的多行註釋

留下跨越多行的註釋也很容易實現並使用以下語法:

/*
This is
a comment on
multiple lines
*/

/* 之間的任何內容 和 */ 無論是在同一行還是多行,字符都將被視為註釋。

您可以了解 Javascript 的詞法語法 在這裡。

為什麼要評論?

廣泛的評論是記錄您的項目的好方法,並且是整體良好的實踐 - 這裡有幾個原因。

向他人解釋自己

您現在可能是您項目中唯一的開發人員 - 但如果它變得流行並且您必須引入其他人來幫助您維護它並添加功能怎麼辦?

原因為什麼 您以您的方式編寫的代碼乍一看可能並不明顯,或者您可能不得不採用一些巧妙的變通方法來處理某個問題。

發表評論以確保您不會為您的同事解決難題。

解釋你自己……對你自己

曾經回顧你幾個月或幾年前所做的事情並想知道,“我為什麼要那樣做?” ?

給自己留言解釋原因,這樣你就不必依賴你的記憶。

用於文檔和調試

通常的做法是,對於應用程序中的每個函數,都應該有一個註釋來解釋它的行為方式——它接受什麼值以及應該輸出什麼值。

這樣,如果您在代碼中尋找錯誤,您可以查看解釋該函數的註釋並仔細檢查該函數是否按預期工作。

留下舊的/有缺陷的代碼

您可以註釋掉代碼,將不再需要的代碼包裝在註釋中,使其不會被執行。

如果您想提醒您如何,這將非常有用 做某事,或者如果您有一些以後可能有用但還不需要的代碼。把它放在評論中以備後用。


Tutorial JavaScript 教程
  1. 使用 Node.js 訂閱 GraphQL

  2. ES6:模板字符串

  3. Netlify 與 Cloudflare 頁面

  4. 使用 Firebase 進行在線井字遊戲

  5. 使用 ES6 在 JavaScript 中進行遞歸、解構和休息/傳播

  6. 如何將獲取的數據存儲在狀態中並將其呈現在我的組件中[關閉]

  7. 30DaysOfHTML 挑戰

  1. 在 React Router v5 和 React 16.9 中使用 Children Props 進行身份驗證路由

  2. 邏輯或 (||) 與空值合併 (??) 運算符

  3. 作為最近的編碼訓練營畢業生,在 COVID-19 期間進行編碼

  4. 我使用 Angular 的第一步

  5. 使用 jQuery 提交後禁用按鈕

  6. 使用 Javascript 或 Jquery 將整數轉換為精度為 2 的浮點數

  7. 帶有 Vuetify 的 Vue.js 應用程序的暗模式切換

  1. 我作為單獨參與者的第一次 React Amsterdam 體驗

  2. 通過實習生獲取瀏覽器信息

  3. 如何使用 NodeJS 編寫視頻流服務器

  4. 如何修復錯誤並且在安裝反應時不會卡住?