這里是云端源想IT,幫你輕松學IT”
嗨~ 今天的你過得還好嗎?
天空一無所求
任樹木自由生長
- 2024.04.22 -
為了提高代碼的可讀性,JS與CSS一樣,也提供了注釋功能。JS中的注釋主要有兩種,分別是單行注釋和多行注釋。
在編程的世界里,注釋是那些默默無聞的英雄,它們靜靜地站在代碼的背后,為后來的維護者、為未來的自己,甚至是為那些偶然間翻閱你代碼的開發者提供著不可或缺的信息。
今天,我們就來深入探討JavaScript中的注釋,讓我們的代碼不僅能夠運行,還能夠“說話”。
JavaScript注釋是用來解釋代碼的,不會被瀏覽器執行。它們可以幫助其他開發者理解代碼的功能和目的。
注釋就像是給代碼穿上了一件華麗的外衣,讓我們的代碼更加優雅、易讀。如下圖中的例子所示:
在JavaScript中,有兩種類型的注釋:單行注釋和多行注釋。下面分別講解這兩種注釋的含義和使用。
1、單行注釋
單行注釋:使用兩個斜杠(//)開頭,后面的內容直到該行結束都被視為注釋。例如:
// 這是一個單行注釋
console.log("Hello, World!"); // 這也是一個單行注釋
它適用于簡短的注釋,比如對某一行代碼的快速說明。
2、多行注釋
多行注釋:使用斜杠星號(/)開頭,星號斜杠(/)結尾,中間的內容都被視為注釋。
例如:
/*
這是一個多行注釋
可以跨越多行
*/
console.log("Hello, World!");
這種注釋可以跨越多行,適合用于函數描述、復雜的算法解釋或者臨時屏蔽代碼塊。
想要快速入門前端開發嗎?推薦一個前端開發基礎課程,這個老師講的特別好,零基礎學習無壓力,知識點結合代碼,邊學邊練,可以免費試看試學,還有各種輔助工具和資料,非常適合新手!點這里前往學習哦!云端源想-程序員必看的精品課程
注意:在HTML文件中,如果需要將JavaScript代碼嵌入到<script>標簽中,可以使用以下方法來添加多行注釋:
<script>
<!--
這是一個多行注釋
可以跨越多行
-->
console.log("Hello, World!");
</script>
1、解釋代碼功能:
通過注釋,我們可以解釋代碼的功能和作用,讓其他程序員更容易理解我們的代碼。
// 這是一個求和函數
function sum(a, b) {
return a + b;
}
2、 標記代碼狀態:
我們可以使用注釋來標記代碼的狀態,例如TODO、FIXME等,提醒自己或其他程序員注意這些問題。
// TODO: 優化這個函數的性能
function slowFunction() {
// ...
}
3、臨時禁用代碼:
當我們需要暫時禁用某段代碼時,可以使用注釋將其包裹起來,而不是直接刪除。
// function oldFunction() {
// // ...
// }
注釋雖好,但過多或不當的注釋反而會成為閱讀代碼的障礙。我們在寫注釋時也要注意以下幾點:
JavaScript注釋是我們編程過程中的得力助手,它們不僅能夠幫助我們更好地理解代碼,還能提高代碼的可讀性和可維護性。讓我們一起學會使用注釋,讓我們的代碼更加精彩!
如果覺得本文對你有所幫助,別忘了點贊和分享哦!
我們下期再見!
END
文案編輯|云端學長
文案配圖|云端學長
內容由:云端源想分享
釋(Comments)用來向用戶提示或解釋某些代碼的作用和功能,它可以出現在代碼中的任何位置。Python解釋器在執行代碼時會忽略注釋,不做任何處理,就好像它不存在一樣。
在調試(Debug)程序的過程中,注釋還可以用來臨時移除無用的代碼。
注釋的最大作用是提高程序的可讀性,沒有注釋的程序簡直就是天書,讓人吐血!
千萬不要認為你自己寫的代碼規范就可以不加注釋,甩給別人一段沒有注釋的代碼是對別人的不尊重,是非常自私的行為;你可以喜歡自虐,但請不要虐待別人。
很多程序員寧愿自己去開發一個應用,也不愿意去修改別人的代碼,沒有合理的注釋是一個重要的原因。雖然良好的代碼可以自成文擋,但我們永遠不清楚今后閱讀這段代碼的人是誰,他是否和你有相同的思路;或者一段時間以后,你自己也不清楚當時寫這段代碼的目的了。
一般情況下,合理的代碼注釋應該占源代碼的1/3左右。
Python支持兩種類型的注釋,分別是單行注釋和多行注釋。
Python使用井號#作為單行注釋的符號,語法格式為:
#注釋內容
從井號#開始,直到這行結束為止的所有內容都是注釋。Python解釋器遇到#時,會忽略它后面的整行內容。
說明多行代碼的功能時一般將注釋放在代碼的上一行,例如:
#使用print輸出字符串
print("Hello World!")
print("開課吧廣場")
print("https://topic.kaikeba.com/biancheng/python")
#使用 print輸出數字
print(100)
print( 3 + 100 * 2)
print( (3 + 100) * 2 )12345678復制代碼類型:[python]
說明單行代碼的功能時一般將注釋放在代碼的右側,例如:
print("https://topic.kaikeba.com/biancheng/python") #輸出Python教程的地址
print( 36.7 * 14.5 ) #輸出乘積
print( 100 % 7 ) #輸出余數123復制代碼類型:[html]
多行注釋指的是一次性注釋程序中多行的內容(包含一行)。
Python使用三個連續的單引號'''或者三個連續的雙引號"""注釋多行內容,具體格式如下:
'''
使用 3 個單引號分別作為注釋的開頭和結尾
可以一次性注釋多行內容
這里面的內容全部是注釋內容
'''12345復制代碼類型:[python]
或者
"""
使用 3 個雙引號分別作為注釋的開頭和結尾
可以一次性注釋多行內容
這里面的內容全部是注釋內容
"""12345復制代碼類型:[python]
多行注釋通常用來為Python文件、模塊、類或者函數等添加版權或者功能描述信息。
注意事項
1)Python多行注釋不支持嵌套,所以下面的寫法是錯誤的:
'''
外層注釋
'''
內層注釋
'''
'''123456復制代碼類型:[python]
2)不管是多行注釋還是單行注釋,當注釋符作為字符串的一部分出現時,就不能再將它們視為注釋標記,而應該看做正常代碼的一部分,例如:
print('''Hello,World!''')
print("""https://topic.kaikeba.com/biancheng/python""")
print("#是單行注釋的開始")123復制代碼類型:[html]
運行結果:
Hello,World!
https://topic.kaikeba.com/biancheng/python
#是單行注釋的開始123復制代碼類型:[html]
對于前兩行代碼,Python沒有將這里的三個引號看作是多行注釋,而是將它們看作字符串的開始和結束標志。
對于第3行代碼,Python也沒有將井號看作單行注釋,而是將它看作字符串的一部分。
給代碼添加說明是注釋的基本作用,除此以外它還有另外一個實用的功能,就是用來調試程序。
舉個例子,如果你覺得某段代碼可能有問題,可以先把這段代碼注釋起來,讓Python解釋器忽略這段代碼,然后再運行。如果程序可以正常執行,則可以說明錯誤就是由這段代碼引起的;反之,如果依然出現相同的錯誤,則可以說明錯誤不是由這段代碼引起的。
在調試程序的過程中使用注釋可以縮小錯誤所在的范圍,提高調試程序的效率。
開課吧廣場-人才學習交流平臺
釋是對程序語言的說明,有助于開發者和用戶之間的交流,方便理解程序。注釋不是編程語句,因此被編譯器忽略。
Java 支持以下三種注釋方式:
1)單行注釋
以雙斜杠“//”標識,只能注釋一行內容,用在注釋信息內容少的地方。打開 Eclipse,在 Java 代碼中使用單行注釋,如圖 1 所示。
圖 1 單行注釋
2)多行注釋
包含在“/*”和“*/”之間,能注釋很多行的內容。為了可讀性比較好,一般首行和尾行不寫注釋信息(這樣也比較美觀好看),如圖 2 所示。
注意:多行注釋可以嵌套單行注釋,但是不能嵌套多行注釋和文檔注釋。
圖 2 多行注釋
3)文檔注釋
包含在“/**”和“*/”之間,也能注釋多行內容,一般用在類、方法和變量上面,用來描述其作用。注釋后,鼠標放在類和變量上面會自動顯示出我們注釋的內容,如圖 3 所示。
注意:文檔注釋能嵌套單行注釋,不能嵌套多行注釋和文檔注釋,一般首行和尾行也不寫注釋信息。
圖 3 文檔注釋
文檔注釋可以通過 Javadoc 命令把文檔注釋中的內容生成文檔,并輸出到 HTML 文件中,方便記錄程序信息。還可以包含一個或多個 @ 標簽,每個 @ 標簽都在新的一行開始。關于 Javadoc 的具體標簽和使用可閱讀學習《Javadoc入門教程》一節。
在 Java 中,一行注釋以雙斜杠“//”標識;多行注釋包含在“/*”和“*/”之間;文檔注釋包含在“/**”和“*/”之間。當編譯器執行到“//”時,就會忽略該行“//”之后的所有文本;當執行到“/*”時,會掃描下一個“*/”并忽略“/*”和“*/”之間的任何文本;當執行到“/**”時,也會掃描下一個“*/”并忽略“/**”和“*/”之間的任何文本內容。
還有更多java學習知識可以看下方視頻,學習更全面,需要源碼資源庫的可以評論區扣'999’免費領取。
「鏈接」
*請認真填寫需求信息,我們會在24小時內與您取得聯系。