docs: 更新代码风格说明

This commit is contained in:
2026-07-21 21:18:09 +08:00
parent e491dd78bf
commit 6a60b4daf4
+5 -2
View File
@@ -34,7 +34,11 @@
- 事件处理函数以 `handle` 开头,例如 `handleSave`;模板事件名采用 kebab-case,例如 `@edit-server` - 事件处理函数以 `handle` 开头,例如 `handleSave`;模板事件名采用 kebab-case,例如 `@edit-server`
- Naive UI 组件使用 `NButton` 等 PascalCase 导入,在模板中写为 `n-button` - Naive UI 组件使用 `NButton` 等 PascalCase 导入,在模板中写为 `n-button`
- 模板属性一行较长时换行,每个属性单独一行,并保持 2 空格缩进。 - 模板属性一行较长时换行,每个属性单独一行,并保持 2 空格缩进。
- 样式采用普通 CSS;类名使用 kebab-case;布局和组件私有样式就近放在对应组件中 - 元素标签内文本简短时,将文本与结束标签放在同一行;较长表达式或动态内容可单独成行
- 样式使用 LessVue SFC 中通过 `<style lang="less">` / `<style lang="less" scoped>` 声明。
- 类名使用 kebab-case;布局和组件私有样式就近放在对应组件中。
- 善用嵌套规则、`&` 父选择器减少重复;全局主题色等公共变量在 App.vue 中通过 CSS 自定义属性定义,命名与 `themeOverrides` 对应(例如 `--frost-primary-color`)。
- 组件内直接使用 `var(--xxx)` 引用全局变量,不再单独定义 Less 变量。
## Electron 分层 ## Electron 分层
@@ -45,5 +49,4 @@
## ESLint ## ESLint
- 使用 `@electron-toolkit/eslint-config` 与 Vue 推荐规则作为基础。 - 使用 `@electron-toolkit/eslint-config` 与 Vue 推荐规则作为基础。
- Vue 组件允许单词名称;未强制默认 Prop;模板单行或多行内容换行规则已关闭。
- 提交前执行 `pnpm lint`,并修复实际报告的问题。 - 提交前执行 `pnpm lint`,并修复实际报告的问题。