背景

之前沒怎么注意注釋的書寫，最近寫uniapp項(xiàng)目，想起注釋來，配置一下HBuilderX的代碼塊。

步驟

HBuilderX 工具 --> 代碼塊設(shè)置 --> 選擇自己想要設(shè)置語言的代碼塊

官方示例

{
    // 注意：本文檔僅支持單行注釋，并且'//'前不能有任何非空字符！??！
    //
    // HBuilderX使用json擴(kuò)展代碼塊，兼容vscode的代碼塊格式
    // 本文檔修改完畢，保存即可生效，無需重啟。
    // 本文檔用于用戶自定義vue代碼塊。
    // 每個(gè)配置項(xiàng)的說明如下：
    // "key"    ：代碼塊顯示名稱，顯示在代碼助手列表中的名字，以下例子中"console.log"就是一個(gè)key。
    // "prefix" ：代碼塊的觸發(fā)字符，就是敲什么字母匹配這個(gè)代碼塊。
    // "body"   ：代碼塊的內(nèi)容。內(nèi)容中有如下特殊格式
    //          $1 表示代碼塊輸入后光標(biāo)的所在位置。如需要多光標(biāo)，就在多個(gè)地方配置$1,如該位置有預(yù)置數(shù)據(jù)，則寫法是${1:foo1}。多選項(xiàng)即下拉候選列表使用${1:foo1/foo2/foo3}
    //          $2 表示代碼塊輸入后再次按tab后光標(biāo)的切換位置tabstops（代碼塊展開后按tab可以跳到下一個(gè)tabstop）
    //          $0代表代碼塊輸入后最終光標(biāo)的所在位置（也可以按回車直接跳過去）。
    //          雙引號(hào)使用\"轉(zhuǎn)義
    //          換行使用多個(gè)數(shù)組表示，每個(gè)行一個(gè)數(shù)組，用雙引號(hào)包圍，并用逗號(hào)分隔
    //          縮進(jìn)需要用\t表示，不能直接輸入縮進(jìn)！
    // "triggerAssist" ：為true表示該代碼塊輸入到文檔后立即在第一個(gè)tabstop上觸發(fā)代碼提示，拉出代碼助手，默認(rèn)為false。
    // 每個(gè)代碼塊以key為主鍵，多個(gè)代碼塊需要逗號(hào)分隔。
    // 如果json語法不合法，底部會(huì)彈出錯(cuò)誤信息，請(qǐng)注意修正。
    // 例子:
    // "console.log": {
    //  "prefix": "logtwo",
    //  "body": [
    //      "console.log('$1');",
    //      "\tconsole.log('$2');"
    //  ],
    //  "triggerAssist": false,
    //  "description": "Log output to console twice"
    // }
}

最簡(jiǎn)單注釋模板

{
      "annotation": {
        "body": [
            "/**",
            "  * @Description: $1",
            "  * @author wangpeng",
            "  * @param {string} a",
            "  * @returns {string}",
            "  */"
        ],
        "prefix": "myan",
        "description": "Automatically generate comments"
    }
}

蠢蠢的自己遇到的問題

本來想在xxx.vue文件中使用注釋代碼塊。
于是興沖沖去寫了vue.json，結(jié)果在vue文件中的<template></template>部分管用，在js部分不管用。
糾結(jié)半天，才想起來，想在vue文件的js部分使用代碼塊，是不是得配置javascript.json呀。
一試果然如此，蠢不蠢

總結(jié)

想在vue文件中使用代碼塊，<template></template>部分的代碼塊在vue.json中配置，js部分的代碼塊在javascript.json中配置。