Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

麻烦看一下 我vscode配置后 vue和小程序的wxml为啥不会自动增加头部注释呢 #605

Open
wangzhipeng-vicky opened this issue Apr 3, 2024 · 0 comments

Comments

@wangzhipeng-vicky
Copy link

`// 头部注释
"fileheader.customMade": {
// Author字段是文件的创建者 可以在specialOptions中更改特殊属性
// 公司项目和个人项目可以配置不同的用户名与邮箱 搜索: gitconfig includeIf 比如: https://ayase.moe/2021/03/09/customized-git-config/
// 自动提取当前git config中的: 用户名、邮箱
"Author": "git config user.name && git config user.email", // 同时获取用户名与邮箱
// "Author": "git config user.name", // 仅获取用户名
// "Author": "git config user.email", // 仅获取邮箱
// "Author": "OBKoro1", // 写死的固定值 不从git config中获取
"Date": "Do not edit", // 文件创建时间(不变)
// LastEditors、LastEditTime、FilePath将会自动更新 如果觉得时间更新的太频繁可以使用throttleTime(默认为1分钟)配置更改更新时间。
"LastEditors": "git config user.name && git config user.email", // 文件最后编辑者 与Author字段一致
// 由于编辑文件就会变更最后编辑时间,多人协作中合并的时候会导致merge
// 可以将时间颗粒度改为周、或者月,这样冲突就减少很多。搜索变更时间格式: dateFormat
"LastEditTime": "Do not edit", // 文件最后编辑时间
// 输出相对路径,类似: /文件夹名称/src/index.js
"FilePath": "Do not edit", // 文件在项目中的相对路径 自动更新
// 插件会自动将光标移动到Description选项中 方便输入 Description字段可以在specialOptions更改
"Description": "", // 介绍文件的作用、文件的入参、出参。
// 可以设置多条自定义信息 设置个性签名、留下QQ、微信联系方式、输入空行等
"custom_string_obkoro1": ""
// 版权声明 保留文件所有权利 自动替换年份 获取git配置的用户名和邮箱
// 版权声明获取git配置, 与Author字段一致: ${git_name} ${git_email} ${git_name_email}
// "custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by ${git_name_email}, All Rights Reserved. "
// "custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by 写死的公司名/用户名, All Rights Reserved. "
},
// 函数注释
"fileheader.cursorMode": {
"description": "", // 函数注释生成之后,光标移动到这里
"param": "", // param 开启函数参数自动提取 需要将光标放在函数行或者函数上方的空白行
"return": ""
},
// 插件配置项
"fileheader.configObj": {
"createHeader": true, // 默认关闭
"autoAdd": true, // 检测文件没有头部注释,自动添加文件头部注释
"autoAlready": true, // 默认开启 只允许插件支持的语言,以及用户通过language 选项自定义的注释。将autoAlready关闭,即给所有文件自动添加头部注释,选择权在你们手上。
"autoAddLine": 900000, // 默认文件超过100行就不再自动添加头部注释
"prohibitAutoAdd": ["json", "md"], // 禁止.json .md文件,自动添加头部注释黑名单
//文件夹或文件名禁止自动添加头部注释
"folderBlacklist": [
"node_modules",
// "文件夹或文件名禁止自动添加头部注释",
"webpack.config.js", // 可以禁止某些文件自动添加注释
"nuxt.config.js", // 可以禁止某些文件自动添加注释
"app.wxss", // 可以禁止某些文件自动添加注释

        "request.js", // 小程序的
        "ToastAndDialog.js", // 小程序的
        "GetLocationBehavior.js", // 小程序的
        "PagingBehavior.js", // 小程序的
        "AuthorizeUtil.js", // 小程序的
        "components", // 小程序的
        "miniprogram_npm", // 小程序的
        "vant", // 小程序的
        "app.js" // 可以禁止某些文件自动添加注释
    ],

    "language": {
        // 针对有特殊要求的文件如:给小程序的wxml设置
        "wxml": {
            "head": "<!--",
            "middle": " * @",
            "end": "-->"
        }
    }
},`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant