标签：git 文件名 url 规范 博客 js CSDN 命名
一、规范命名的重要性
易懂、通用、规范、标准、专业性、是经验积累的体现
1.1、常见命名方法
| 序号 | 命名方法 | 解释 |
| 1 | 全小写 | |
| 2 | 全大写 | |
| 3 | 驼峰：小驼峰命名法 | |
| 4 | 驼峰：大驼峰命名法 | |
| 5 | 烤串命名法 / 脊柱命名法 | |
| 6 | 下划线分隔法 | |
二、项目名
采用小写字母和中划线（-）连接的方式命名，如my-project
| 序号 | 规则 | 举例 |
| 1 | 采用小写字母和中划线（-）连接的方式命名 | my-project |
三、目录 / 文件夹
重要：目录架构既要符合前端行业通用规则，又要满足项目的业务架构。层次分明，分工明确，从目录架构反过来能理解整个项目的业务架构。
3.1、整体原则
| 序号 | 原则 | 解释 |
| 1 | 简洁明了 | 命名应简洁明了，能够清晰地表达文件夹/目录的用途或内容。 |
| 2 | 一致性 | 在整个项目中保持命名规则的一致性，以便其他开发者能够快速理解和使用。 |
| 3 | 小写字母 | 为了避免大小写敏感问题，建议使用小写字母进行命名。 |
| 4 | 使用连字符 | 如果文件名包含多个单词，建议使用连字符（-）或下划线（_）进行分隔，但通常连字符在前端项目中更为常见。 |
3.2、具体规则
| 序号 | 规则 | 举例 |
| 1 | 采用小驼峰（camelCase）命名法 即第一个单词首字母小写，后续单词首字母大写。 如有复数结构时（此文件夹包含多个子文件夹或文件），可以采用复数命名法，如components、assets | camelCase |
| 2 | 也可以考虑使用小写字母和中划线（-）连接的方式，但这种方式在前端项目中较少见，更多用于文件名或类、ID的命名 | my-task |
3.3、通用命名
| 序号 | 名称 | 解释 |
| 1 | src | 包含源代码的文件夹 |
| 2 | components | 包含Vue组件的文件夹（复数命名） |
| 3 | assets | 包含静态资源的文件夹（复数命名） |
| 4 | utils | 包含工具函数的文件夹（复数命名） |
| 5 | views | 包含路由页面的文件夹（复数命名） |
3.4、注意事项
| 序号 | 事项 | 解释 |
| 1 | 避免使用保留字 | 避免使用操作系统或编程语言中的保留字作为文件夹/目录名，以免引起冲突或误解。 |
| 2 | 避免使用空格和特殊字符 | 空格和特殊字符可能会在某些环境下导致问题，因此建议使用下划线（_）或中划线（-）作为单词之间的分隔符。 |
| 3 | 考虑国际化 | 如果项目需要支持多种语言，命名时应考虑国际化因素，避免使用具有特定文化含义的词汇。 |
3.5、gitee / github 实例
| 序号 | 来源 / 项目 | 截图 | 目录分析 |
| 1 | gitee / vue |   | 1、小写命名
2、中划线 / '-' 命名
git,文件名,url,规范,博客,js,CSDN,命名
From： https://blog.csdn.net/snowball_li/article/details/125314797
相关文章
- 开源的 API 学习平台「GitHub 热点速览」
前有5万颗星标的开源项目HTTPie因误操作导致Star清零（2022年），上周知名开源项目Elasticsearch也经历了Star一夜清零的事件。这些事故的原因均是管理员误将开源项目从公开状态转为私有状态所导致。为避免类似事件再次发生，GitHub已在转为私有的功能处增加了两次确认步骤，并...... - curl文档
命令目录curlcurl是一个利用URL规则在命令行下工作的文件传输工具，可以说是一款很强大的http命令行工具。它支持文件的上传和下载，是综合传输工具，但按传统，习惯称url为下载工具#-o把url的内容输出到指定文件,而不是标准输出(控制台)#把阿里yum源下载下来,输出到文件/etc/yu...... - git原理与上传
言：git是一个软件，gitee/github是一个网站，这里有什么联系吗？我们身为一个程序员不可能不知道github，但是毕竟这是外国的网站，我们不翻墙的情况下，是无法访问的(或者就是太慢了，或者就是英语不好的同学不想使用)，所以可以使用中国的平替gitee。我们一般通过它用来上传代码，但是各位可能...... - 电能表预付费系统-标准传输规范(STS)（32）
6.5.4STA:EncryptionAlgorithm076.5.4.1EncryptionprocessTheStandardTransferAlgorithmencryptionprocessisshowninFigure12,whichcomprisesakeyalignmentprocessand16iterationsofasubstitution,permutationandkeyrotationprocess. ...... - 电能表预付费系统-标准传输规范(STS)（33）
6.5.4.4Keyrotationprocess 按键旋转过程TheentirekeyisrotatedonebitpositiontotheleftasillustratedinFigure15.整个密钥向左旋转一个位，如图15所示。6.5.4.5WorkedexampletogenerateTokenDataforaTransferCredittokenusingtheSTA 使用ST...... - git-manifest-url学习笔记
repo初始化仓库，一次下载多个Git仓库的内容repoinit--repo-url 指定repo工具的自身仓库地址-u指定要同步的分支名称 -blinux-m 指定manifest文件中要使用的具体manifest文件-u：指定manifest仓库的URL。Manifest仓库包含了所有需要同步的Git仓库的信息，以及这些仓库...... - 前端技术探秘-Nodejs的CommonJS规范实现原理
了解Node.jsNode.js是一个基于ChromeV8引擎的JavaScript运行环境，使用了一个事件驱动、非阻塞式I/O模型，让JavaScript运行在服务端的开发平台，它让JavaScript成为与PHP、Python、Perl、Ruby等服务端语言平起平坐的脚本语言。Node中增添了很多内置的模块，提供各种各样的功能，同时也提...... - URL-统一资源定位符
URL（UniformResourceLocator，统一资源定位符）是用来定位互联网上资源的地址。它是一个特定格式的字符串，通常包含以下几个部分：1.协议：指示如何访问资源，例如`http://`或`https://`。2.主机名：资源所在的服务器地址，例如`www.example.com`。3.端口（可选）：用于指定服务器上的特...... - 在没有curl和wget情况下发送HTTP请求
Bash的 /dev/tcp 功能为用户提供了一个直接的方式，通过TCP套接字发送HTTP请求，这一功能可以在没有额外工具的情况下执行简单的网络操作。发送HTTPGET请求#!/bin/bash#打开一个TCP连接到baidu.com的80端口，并将其分配给文件描述符3exec3<>/dev/tcp/baidu.com/80...... - 三周精通FastAPI：30 API、标签元数据和文档 URL
官方文档：https://fastapi.tiangolo.com/zh/tutorial/metadata/API元数据和文档URL¶你可以在FastAPI应用程序中自定义多个元数据配置。API元数据¶你可以在设置OpenAPI规范和自动API文档UI中使用的以下字段：参数类型描述titlestrAPI的标题。summarystrAPI的简......
|