前端的开发规范

简介: 前端的开发规范

作为一个程序员开发规范是相当重要的,因为遵守开发规范有很多好处:

  • 规范的代码可以促进团队合作;
  • 规范的代码可以减少bug处理;
  • 规范的代码可以降低维护成本;
  • 规范的代码有助于代码审查;
  • 养成代码规范的习惯,有助于程序员自身的成长;

而规范的目的:为了提高工作效率,便于后台人员添加功能及前端后期优化维护,输出高质量的文档。 在项目构建中,使结构更加清晰,代码简明有序,有一个更好的前端架构。

具体的有:从命名上面

驼峰式命名法介绍

  • Pascal Case 大驼峰式命名法:首字母大写。eg:StudentInfo、UserInfo、ProductInfo
  • Camel Case 小驼峰式命名法:首字母小写。eg:studentInfo、userInfo、productInfo文件资源命名

 

  • 文件名不得含有空格
  • 文件名建议只使用小写字母,不使用大写字母。( 为了醒目,某些说明文件的文件名,可以使用大写字母,比如README、LICENSE。 )
  • 文件名包含多个单词时,单词之间建议使用半角的连词线 ( - ) 分隔。
  • 引入资源使用相对路径,不要指定资源所带的具体协议 ( http:,https: ) ,除非这两者协议都不可用

变量命名

命名方式 : 小驼峰式命名方法

命名规范 : 类型+对象描述的方式,如果没有明确的类型,就可以使前缀为名词

函数

命名方式 : 小驼峰方式 ( 构造函数使用大驼峰命名法 )

命名规则 : 前缀为动词

常量

命名方法 : 全部大写

命名规范 : 使用大写字母和下划线来组合命名,下划线用以分割单词

类的成员

  • 公共属性和方法 : 同变量命名方式
  • 私有属性和方法 : 前缀为下划线(_)后面跟公共属性和方法一样的命名方式

但是在不同开发环境中需要根据实际情况来规范不同的开发规则

目录
打赏
0
0
0
0
15
分享
相关文章
好程序员web前端分享前端的开发规范
本文好程序员主要从以下几个方面来概述前端的开发规范1.目录构建规范2.前端命名规范3.前端工作规范4.开发文档的书写规范 前端目录构建规范我们从命名原则、根目录、业务逻辑等方面进行目录构建 1.1 命名原则: 简洁明了(如下:) src 源代码 img 图片资源 js JavaScript脚本 dep 第三方依赖包 不使用复数(如下:) 不使用 imgs docs 1.
2249 0
前端大模型应用笔记(三):Vue3+Antdv+transformers+本地模型实现浏览器端侧增强搜索
本文介绍了一个纯前端实现的增强列表搜索应用,通过使用Transformer模型,实现了更智能的搜索功能,如使用“番茄”可以搜索到“西红柿”。项目基于Vue3和Ant Design Vue,使用了Xenova的bge-base-zh-v1.5模型。文章详细介绍了从环境搭建、数据准备到具体实现的全过程,并展示了实际效果和待改进点。
465 14
前端大模型应用笔记(一):两个指令反过来说大模型就理解不了啦?或许该让第三者插足啦 -通过引入中间LLM预处理用户输入以提高多任务处理能力
本文探讨了在多任务处理场景下,自然语言指令解析的困境及解决方案。通过增加一个LLM解析层,将复杂的指令拆解为多个明确的步骤,明确操作类型与对象识别,处理任务依赖关系,并将自然语言转化为具体的工具命令,从而提高指令解析的准确性和执行效率。
164 6
前端大模型应用笔记(四):如何在资源受限例如1核和1G内存的端侧或ECS上运行一个合适的向量存储库及如何优化
本文探讨了在资源受限的嵌入式设备(如1核处理器和1GB内存)上实现高效向量存储和检索的方法,旨在支持端侧大模型应用。文章分析了Annoy、HNSWLib、NMSLib、FLANN、VP-Trees和Lshbox等向量存储库的特点与适用场景,推荐Annoy作为多数情况下的首选方案,并提出了数据预处理、索引优化、查询优化等策略以提升性能。通过这些方法,即使在资源受限的环境中也能实现高效的向量检索。
185 1
前端大模型应用笔记(二):最新llama3.2小参数版本1B的古董机测试 - 支持128K上下文,表现优异,和移动端更配
llama3.1支持128K上下文,6万字+输入,适用于多种场景。模型能力超出预期,但处理中文时需加中英翻译。测试显示,其英文支持较好,中文则需改进。llama3.2 1B参数量小,适合移动端和资源受限环境,可在阿里云2vCPU和4G ECS上运行。
307 1

热门文章

最新文章

AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等