Javascript 評論

| | | | | | | | | | | | | | | | | | | |

JavaScript 註釋用於在代碼中編寫註釋或禁用代碼部分而不刪除它們。註釋是在 JavaScript 中通過附加 // 單行或 / * before and * / 多行之後。

評論代碼是許多編程語言的基本特徵。代碼註釋背後的想法是,雖然您的代碼將被計算機讀取,但您的代碼也將被人類讀取,因此人們易於理解您編寫的代碼非常重要。

註釋允許您可以在編程時跟踪您的代碼,並讓您有機會記下將來可能有用的筆記。此外,如果您在團隊中工作,編寫註釋將有助於確保任何可能需要為您的工作做出貢獻的人都可以閱讀您的代碼。

在本教程中,我們將討論如何在JavaScript。我們將從討論 JavaScript 中註釋的價值開始,然後看看可用於在 JavaScript 中編寫註釋的語法。

關於代碼的註釋

關於主題是編寫可讀和可管理的代碼的重要部分。事實是,如果你能理解你今天編寫的代碼,就不能保證你明天就能有效地描述它的作用。此外,如果您與其他人一起工作,他們很可能不理解您正在編寫的某些代碼。

是註釋的來源。註釋是編譯器忽略的語句,並且可以用來解釋你的 JavaScript 代碼。

作為一名開發人員,在你的代碼上寫註釋可以讓你更有效地跟踪你在做什麼。在編寫代碼時,您可以編寫註釋,以幫助您更好地理解代碼並理解您之前編寫的代碼背後的意圖。寫評論對於可能看到您的代碼的其他人也很有用,因為評論可能會幫助他們更深入地了解您的代碼是如何工作的。

每個開發者寫評論的方式不同,但一般規則是註釋應該用來解釋你的代碼背後的意圖。畢竟你的代碼會說話,但是以某種方式編寫代碼的原因往往不是。因此,通過編寫註釋,你可以解釋你為什麼接近一個以某種方式解決問題,這使您和其他人以後更容易理解您的程序是如何工作的。

JavaScript 註釋

在 JavaScript 中使用了兩種類型的註釋:。單行註釋和塊註釋

單行註釋是用兩個正斜杠(//)寫的,寫在一行代碼上。 "//" 聲明 之後的任何字符都將被忽略,直到行尾。下面是 JavaScript 中單行註釋的示例:

// 這是一行註釋

塊是用開頭和結束標籤並允許您將註釋寫成多行。塊註釋的開始和結束標記是:

塊註釋有時稱為多行註釋,看起來像多行 CSS 註釋。下面是 JavaScript 中的塊註釋示例:

編譯器將忽略我們開始和結束標記之間的所有代碼。

任何類型的註釋都可以用來解釋你的代碼並討論你背後的意圖代碼。以下是解釋基本變量聲明的註釋示例:

// 聲明“巧克力”變量以將巧克力類型存儲為數組

var Chocolate = [`Dark` ,`Milk`,`White`,`hazelnuts`,`Caramel`];

所有編程語言中的註釋“Äã,Äã應該隨著代碼的變化而經常更新。因此,如果我們決定將我們的變量名重命名為“chocolate_types”,我們需要更新我們的註釋以確保它反映新的變量名。事實上,程序變得更大,它們經常會發生顯著變化,所以更新很重要註釋和代碼

評論代碼

註釋通常用於兩個目的之一。第一個,正如我們在本文中討論的那樣,是解釋代碼背後的意圖並消除任何混淆。其次是防止在測試期間執行代碼。

註釋代碼允許您中斷一行或多行代碼的執行,而無需從程序中完全刪除代碼。調試時註釋很常見,因為您可以嘗試多種解決方案並保存代碼以供以後使用

這是註釋掉一行代碼的示例註釋。

當我們運行我們的程序時,編譯器會運行聲明變量的那行代碼 我們註釋掉了“flavors” 因為它包含錯誤,我們需要調試問題。在這種情況下,我們忘記在變量名 ("flavors") 和變量值(我們的風味範圍)之間加上等號。

要么分解每個我們已經討論過的兩種類型的註釋,並探討了它們的使用方法。

單行註釋

單行註釋,也稱為內聯註釋,用於註釋掉部分一行代碼或一行代碼。以下是單行 JavaScript 註釋的示例:

在此註釋中,我們聲明了一個 "first_type" 變量,它將第一個值存儲在我們的 “巧克力”表。接下來,我們將在行尾添加內聯註釋來解釋代碼背後的意圖。

單行註釋通常用於對您的代碼進行簡短註釋或描述代碼背後的意圖特定的代碼行。但是,單行註釋不是您應該使用的唯一註釋類型。如果需要解釋更大的函數,最好寫塊註釋

批量註釋

批量註釋寫成多行,用於解釋大部分代碼。雖然單行註釋通常解釋一行代碼,但註釋塊可以解釋一個函數或文件的函數。

多行從函數或文件的開頭開始,大多數情況下這是用於解釋循環的塊註釋示例:

我們的塊註釋跨越 t 行 re,用於描述在我們的“for”循環中編寫的十個代碼。

塊註釋也可以在開頭找到用於解釋文件用途或包含有關文件作者和版本的信息。以下是包含文件作者和 JavaScript 中的創建日期的片段示例:

結論

在代碼上寫註釋可以讓你寫出更具可讀性和可維護性的代碼。您可以使用註釋來跟踪您自己的代碼,並讓其他使用您的代碼的人更容易理解其用途。

在本教程中,我們討論了註釋的基礎知識,然後探討如何編寫 JavaScript 註釋。我們還討論了兩種主要類型的註釋 - 單行和多行 - 並展示了每種註釋代碼的實際示例。最後,我們討論了註釋和代碼註釋之間的區別。

您現在可以像專家一樣編寫 JavaScript 評論了!