Skip to content

Latest commit

 

History

History
65 lines (49 loc) · 1.97 KB

naming.md

File metadata and controls

65 lines (49 loc) · 1.97 KB

命名规范

介绍

常见命名规范有4种

  • 下划线命名 my_first_name
  • 中划线命名 my-first-name
  • 小驼峰命名 myFirstName
  • 大驼峰命名 MyFirstElement

使用

文件夹

场景 说明 示例
项目名称 小驼峰 my-app
测试文件夹 前后双下划线 __test__
普通文件夹 中横线 my-first-name
工具文件夹 单下划线 _util

文件名

场景 说明 示例
多语言 特殊 README-zh_CN.md
文档 下划线 CODE_OF_CONDUCT.md
文件 中横线 docker-compose.yml
配置 特殊 .npmignore

css

场景 说明 示例
class类 中横线 my-first-name

javascript

场景 说明 示例
全局变量 全大写 ENV
变量 小驼峰 prefixCls
方法 小驼峰 getInputElement
实例 大驼峰 ConfigConsumer
工具方法 小驼峰 getStatusClassNames

react

场景 说明 示例
hook 小驼峰 useModel
JSX 大驼峰 ArrowLeftOutlined
全局组件 大驼峰 Header.tsx
组件函数 大驼峰 ModeSwitch

typescript

场景 说明 示例 备注
对象类型 大驼峰 DataSourceItemObject 名称+Object
复合类型 大驼峰 DataSourceItemType 名称+Type
使用的 大驼峰 DataSourceItemType 使用用这个
props 大驼峰 InternalSelectProps 名称+Props

引用