前端开发规范
发布日期:2021-05-18 08:38:19 浏览次数:20 分类:精选文章

本文共 929 字,大约阅读时间需要 3 分钟。

命名规范与代码写作技巧

  • 变量命名
    • 首字母小写,采用驼峰式命名,如myReact。
    • 命名时使用set、get等前缀,例如setCount(设置操作)、getCount(获取操作)。
    1. 组件命名
      • 首字母大写,采用驼峰式命名,例如class MyReact extends Component。
      1. 常量命名
        • 全部字母大写,使用下划线分隔且表达清晰,如MY_REACT_PROJECT。
        1. 函数命名
          • 首字母小写,采用驼峰式命名,如myReact = () => { }.
          • 使用箭头函数,单参数时必须带括号如( ) => { }。
          1. 模板语法
            • 避免使用连接字符串,用模板字符串替代,例如www.${name}.com
            1. 变量声明
              • 使用let或const声明,禁止使用var。
              • 代码一行结束时必须有分号。
              1. 数组与对象初始化
                • 简单元素可在一行声明,如let arr1 = [];.
                • 复杂元素应换行,并确保最后一个元素后无逗号。
                1. 比较操作
                  • 类型严格比较,仅判断null或undefined时可用===。
                  • 避免使用==,防止隐式类型转换。
                  1. 代码创建方式
                    • 使用字面量创造,如let obj = {} 或let arr = [].
                    • 尽量使用解构赋值,如let {a, b} = {a:1, b:2, c:3}.
                    1. 对象键名处理
                      • 当所有键名一致时可用缩写,如{ x, y, x }.
                      • 如果存在不同情况,不建议使用缩写。

                      注释规范

                      1. 行内注释
                        • 单独行注释使用//,注释前空一行。
                        • 代码后注释需前有空格,如// 注释内容.
                        1. 函数注释
                          • 带有参数和返回值时必须使用标识,内容需清晰完整。

                          代码示例

                          let foo = {x, y, x} // 简洁的对象声明 function abc() { // 行内注释可用多行 return a = 1; // 添加注释 }

                          // 使用JSDoc注释示例 /**

                          • @param {string} p1 参数说明
                          • @param {string} p2 参数说明
                          • @return {object} 返回值说明 */ function foo(p1, p2, p3 = 10) { let p3 = p3 || 10; return { p1, p2, p3 }; }
    上一篇:Webstorm实用的强烈推荐的插件介绍
    下一篇:antd select 等组件可搜索问题

    发表评论

    最新留言

    不错!
    [***.144.177.141]2025年04月20日 05时02分54秒

    关于作者

        喝酒易醉,品茶养心,人生如梦,品茶悟道,何以解忧?唯有杜康!
    -- 愿君每日到此一游!

    推荐文章

    Kubernetes学习总结(3)——一年时间打造全球最大规模之一的Kubernetes集群,蚂蚁金服怎么做到的? 2025-04-03
    Kubernetes学习总结(4)——Kubernetes v1.20 重磅发布 | 新版本核心主题 & 主要变化解读 2025-04-03
    Kubernetes学习总结(5)——Kubernetes 常见面试题汇总 2025-04-03
    Kubernetes学习总结(6)——Kubernetes 7周年:它为什么如此受欢迎? 2025-04-03
    Kubernetes学习总结(7)——学习 Kubernetes 的 Pod 2025-04-03
    Kubernetes学习总结(8)—— Kubernetes Pod 资源管理 和 Pod 服务质量 2025-04-03
    Kubernetes学习总结(9)—— 基础架构的未来是 K8s,那么 K8s 的未来在何方? 2025-04-03
    kubernetes实战(十三):k8s使用helm持久化部署harbor集成openLDAP登录 2025-04-03
    Kubernetes实战(一)-Kubernetes集群搭建 2025-04-03
    Kubernetes实战(七)-优先级调度(Pod Priority Preemption) 2025-04-03
    Kubernetes实战(三十一)-Calico网络部署(推荐) 2025-04-03
    Kubernetes实战(三十三)-外部Etcd集群部署与调优(更安全的数据存储策略) 2025-04-03
    Kubernetes实战(三十二)-Kubeadm 安装 Kubernetes v1.24.0 2025-04-03
    Kubernetes实战(三)-定向调度(NodeSelector) 2025-04-03
    Kubernetes实战(二十九)-集群资源管理(CPU & Memory) 2025-04-03
    Kubernetes实战(二十二)-Etcd 集群部署(安全) 2025-04-03
    Kubernetes实战(二十五)-Flannel 网络部署(不推荐,不支持 Etcd3) 2025-04-03
    Kubernetes实战(二十八)-环境共享与隔离(Namespace) 2025-04-03
    Kubernetes实战(二十四)-kubernetes二进制文件方式部署集群(安全)(下) 2025-04-03
    Kubernetes实战(十五)-敏感数据管理(Secret) 2025-04-03