首頁 > web前端 > js教程 > 主體

深入理解JS程式碼註解方法及程式碼註解規範

yulia
發布: 2018-10-10 14:35:52
原創
9253 人瀏覽過

在頁面佈局時,為了提高程式碼的可讀性,常常需要為程式碼加註釋,這篇文章就和大家聊聊JS怎麼註釋程式碼以及JS程式碼註解的規範,有興趣的朋友可以參考一下,希望對你有幫助!

註解是程式碼不可或缺的一部分,一個完整的程式必須要加註解。註釋不僅有利於自己更新和修改項目,還有利於其他人拿到你的項目時知道你寫的什麼。

一、JavaScript程式碼註解方法

JavaScript不會執行註解裡面的程式碼,JS程式碼註解分成單行註解和多行註解。

1、單行註解

單行註解以//開頭,//後面要加一個空格,然後再寫註解的內容,單行註解可用於描述目前程式碼的作用,解釋程式碼等等。

程式碼實例:給document.write("字串是:" str)程式碼單行註釋,不需要其顯示在頁面上

<script type="text/javascript">
  function myFunction(){
   var animal = ["dog", "cat", "elephant", "tiger"];
   var str=animal.toString();
   document.write("类型是:"+typeof(str));  
   //document.write("字符串是:"+str)
  }  
 </script>
登入後複製

註解前效果圖:

深入理解JS程式碼註解方法及程式碼註解規範

註解後效果圖:

深入理解JS程式碼註解方法及程式碼註解規範

2、多行註解

多行註解以/* 開始,以*/ 結尾,但是工作中要盡量使用單行註解取代多行註釋,即使註解需要多行,也要用單行註解來完成,但是函數的註解還是建議使用多行註解。

程式碼實例:

<script>
/*
下面的这些代码会输出
一个标题和一个段落
并将代表主页的开始
*/
document.getElementById("myH1").innerHTML="欢迎来到菜鸟教程";
document.getElementById("myP").innerHTML="这是一个段落。";
</script>
登入後複製

二、JS程式碼註解的規格

一個好的程式碼註解要做到,如果沒有必要,則不要加註釋,如果需要加註釋,則寫詳細,讓別人明白你的意思,盡量提高程式碼的清晰性和可讀性。工作中要做到以下幾點:

1、在有邏輯的程式碼中,程式碼的註解要在20%以上

2、檔案註解時,檔案註解寫入檔案的當頭部

3、類別和介面的註解時,註解需要放在class之前,using或package關鍵字之後

4、遇到類別屬性、公有和保護方法時,註釋需要寫在類別屬性、公有、保護方法上面。即用//註解,需要對齊被註解的程式碼

5、註解需要放在被註解的程式碼前面,分行寫且中間不要留空行

6、不要在註解中使用縮寫,如果要用縮寫,需要對縮寫進行必要的解釋說明

7、成員變數註釋內容時,成員變數的意義、目的和功能,可能被用到的地方,用//來註解,需要對齊被註解的程式碼

總之,每個程式設計師都應該養成一個寫註解的好習慣,不僅方便自己閱讀和修改程式碼,而且還方便別人理解和維護你的程式碼。

以上介紹了JS程式碼的註解方法以及JS程式碼的註解規範,比較簡單,容易理解,更多相關教學請造訪 JavaScript影片教學

#

以上是深入理解JS程式碼註解方法及程式碼註解規範的詳細內容。更多資訊請關注PHP中文網其他相關文章!

相關標籤:
來源:php.cn
本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
最新問題
熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板