微信小程序注釋詳解

一、微信小程序注釋的意義

1、注釋是什麼

注釋是程序員在編寫代碼時用於記錄、解釋某段代碼或函數作用、實現方式等等的一種特殊字符組合。注釋在程序的運行中並不會被編譯，不會改變程序的功能與結果，是方便程序員開發和閱讀代碼的重要工具。

2、注釋作用

微信小程序注釋在開發中是不可或缺的，它可以提高代碼可讀性，幫助團隊合作開發，預防出現潛在代碼錯誤，便於後續維護等等。微信小程序注釋能夠更好地組織和完善代碼結構，減少代碼質量問題，提高代碼的可讀性和可維護性。

//單行注釋
var name = "張三"; //定義姓名

/*
多行注釋
這裡是注釋的內容
*/
var age = 18; //定義年齡

二、微信小程序注釋的語法

微信小程序注釋分為單行注釋和多行注釋，在微信小程序中使用的注釋風格與其他編程語言類似，主要有以下兩種注釋：

1、單行注釋

在一行代碼的末尾後使用兩個斜杠（//）來添加一行注釋，注釋的內容將被視為該行代碼的解釋說明，對於該行代碼起到了解釋作用。當代碼執行的時候，這行注釋將被忽略。

//這是一行注釋
var name = "張三"; //定義姓名

2、多行注釋

多行注釋以 /* 符號開始，以 */ 符號結束。多行注釋允許一次注釋多行代碼，注釋內容不會被編譯，對於程序的執行沒有任何影響。

/*
這是一個
多行注釋
*/
var age = 18; //定義年齡

三、微信小程序注釋的規範

注釋是編寫代碼的一個重要方法，為了更好地組織和維護代碼，注釋同樣需要規範化。下面是微信小程序注釋的規範：

1、注釋內容

注釋應該清晰而簡潔，不應與代碼邏輯相衝突。注釋應包括注釋類型、意義、參數、返回值、例子等等。

2、注釋風格

在微信小程序中使用注釋的風格應該遵循“單行注釋”和“多行注釋”兩種風格，並且避免在代碼中出現無用、冗餘的注釋。

3、注釋位置

注釋應該緊靠需要注釋的代碼塊之前，注釋和代碼之間應該空一格。

4、注釋標識

在微信小程序中常用的注釋標識有“TODO”和“FIXME”等，表示需進一步修改的地方或需要注意的地方，增加了代碼的可讀性和便於維護。

四、微信小程序注釋的實例

小程序獲取用戶信息

// 獲取用戶信息
getUserInfo: function (cb) {   //cb 為獲取成功後的回調函數
  var that = this
  wx.getUserInfo({
    success: function (res) {
      typeof cb == "function" && cb(that.globalData.userInfo = res.userInfo) //處理獲取成功後的回調函數
    },
    fail: function () {  //獲取用戶信息失敗
      wx.showModal({
        title: '警告',
        content: '您點擊了拒絕授權，將無法正常使用小程序的功能體驗。請10分鐘後再次點擊授權，或者刪除小程序重新進入。',
        showCancel: false,
        confirmText: '我知道了',
        success: function (res) {
          if (res.confirm) {
            console.log('用戶點擊了“我知道了”')
          }
        }
      })
    }
  })
},

小程序頁面跳轉

// 頁面跳轉
navigateTo: function (event) {
  var url = event.currentTarget.dataset.url
  wx.navigateTo({
    url: url,
    success: function () {
      console.log('success！') //成功跳轉
    },
    fail: function () {  //跳轉失敗
      console.log('fail！')
    }
  })
},

小程序下拉刷新

//下拉刷新
onPullDownRefresh: function () {
  wx.showNavigationBarLoading() //顯示導航條加載動畫
  this.getData();
  wx.hideNavigationBarLoading() //隱藏導航條加載動畫
  wx.stopPullDownRefresh() //停止當前頁面下拉刷新
},

小程序彈框提示

//彈框提示
wx.showModal({
  title: '提示',
  content: '這是一個模態彈窗',
  success: function (res) {
    if (res.confirm) {
      console.log('用戶點擊確定')
    } else if (res.cancel) {
      console.log('用戶點擊取消')
    }
  }
})

小程序獲取系統信息

//獲取系統信息
wx.getSystemInfo({
  success: function (res) {
    console.log('系統信息：', res)
  }
})

總結

經過總結，我們可以知道微信小程序注釋能夠提高代碼可讀性，幫助團隊合作開發，預防出現潛在代碼錯誤，便於後續維護等等。注釋分為單行注釋和多行注釋，注釋應該清晰而簡潔，不應與代碼邏輯相衝突。在編寫過程中同樣需要遵循規範，注釋應該緊靠需要注釋的代碼塊之前。下次開發小程序時，注釋要記得加哦！