yhsoft/dev-aid
6
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

新增编码规范

Browse Source
This commit is contained in:
徐永兴 2023-10-27 16:03:59 +08:00
parent bccaa32b6f
commit 7f7fc1406d
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
工作规范/编码规范.md
View File

@ -18,14 +18,16 @@
- 标签名必须使用小写字母，标签使用要遵循其语义 - 标签名必须使用小写字母，标签使用要遵循其语义
- 标签属性名必须使用小写字母，属性必须用双引号（""）包围，自定义属性以 data- 作为前缀 - 标签属性名必须使用小写字母，属性必须用双引号（""）包围，自定义属性以 data- 作为前缀
- bool 类型的属性不需要添加属性值 - bool 类型的属性不需要添加属性值
- class 必须单词全字母小写，单词之间以 '-' 分隔 - class 使用短横线式（kebab-case）命名，单词之间以 '-' 分隔，不允许使用大写字母
- id 必须保证同一个页面内唯一，使用小驼峰式命名（camelCase） - id 必须保证同一个页面内唯一，使用小驼峰式命名（camelCase）
- 如果使用第三方组件库，尽可能二次封装组件库，减少自定义组件的使用。 - 如果使用第三方组件库，尽可能二次封装组件库，减少自定义组件的使用。
- 引用的文件名称使用短横线式（kebab-case）命名，静态资源文件一般放在类似 assets/images 的目录中
### CSS / LESS / SCSS ### CSS / LESS / SCSS
- 类名使用 kebab-case（短横线）式命名，禁止出现大写字母
- 禁止使用 style 行内样式 - 禁止使用 style 行内样式
- class 样式尽可能使用 TailwindCSS 或 UnoCSS，尽可能避免编写和维护大量特定样式 - 样式推荐使用 TailwindCSS 或 UnoCSS，尽可能避免编写和维护大量特定样式
### JavaScript ### JavaScript