update
This commit is contained in:
10
Common.md
10
Common.md
@@ -66,3 +66,13 @@ NodeJS, NSIS, axios, pinia, Less, 微信小程序等现代程序知识
|
||||
## 项目环境
|
||||
|
||||
开发环境使用 Windows,不要使用其他系统指令操作项目
|
||||
|
||||
## 通用代码约束
|
||||
|
||||
- 所有文字、评论和文档均为中文
|
||||
- 重复 API 调用必要时通过存储进行缓存或协调
|
||||
- 不用繁重的计算阻塞主线程, 卸载或推迟
|
||||
- 使用 tab 缩进,而不是空格
|
||||
- 数值比较应该使用小于,即使常量在前变量在后
|
||||
- 注释不需要标注类型,一句话注释不需要句号
|
||||
- 布尔值注释直接说明使用 true 的效果,例如: true 为启用
|
||||
|
||||
@@ -1,7 +1,3 @@
|
||||
## 系统上下文
|
||||
|
||||
这是一个 Electron 框架的桌面程序,它的主要功能为 *
|
||||
|
||||
## 技术栈和限制
|
||||
|
||||
- 运行时:Electron
|
||||
@@ -30,3 +26,7 @@ src/
|
||||
Root.vue
|
||||
main.ts
|
||||
```
|
||||
|
||||
## Electron 约束
|
||||
|
||||
- 校验代码不要主动执行构建 Electron 生产产物,这非常耗时,只需开发环境校验即可
|
||||
|
||||
@@ -11,15 +11,11 @@
|
||||
|
||||
## Java 代码约束
|
||||
|
||||
- 使用 tab 缩进,而不是空格
|
||||
- 类、方法、变量注释需要符合 javadoc 标准,拥有完整的类型、参数、返回、异常等说明
|
||||
- 优先使用字符串模板,且是 JDK15 的 "".formatted() 方法
|
||||
- 字符串超长且动态时使用 StringBuilder
|
||||
- 数值比较应该使用小于,即使常量在前变量在后
|
||||
- 仅使用上述工具。除非堆栈无法合理地解决外部依赖关系,否则不要引入外部依赖关系
|
||||
- 在编写自定义实现之前,首选所选工具中的官方 API
|
||||
- 该项目目前没有测试, 除非明确要求,否则不要添加测试
|
||||
- 所有文字、评论和文档均为中文
|
||||
- 不在没有充分理由的情况下添加外部库
|
||||
- 不用繁重的计算阻塞主线程, 卸载或推迟
|
||||
- 重复 API 调用必要时通过存储进行缓存或协调
|
||||
- 字段的一句话注释不要使用多行,直接使用 /** 注释内容 */
|
||||
|
||||
6
WeChat.md
Normal file
6
WeChat.md
Normal file
@@ -0,0 +1,6 @@
|
||||
## 微信小程序约束
|
||||
|
||||
- 请使用 LESS 而非微信原生 WXSS
|
||||
- 请勿使用原生 HTML 标签
|
||||
- 样式使用 rpx 作为单位
|
||||
|
||||
@@ -10,7 +10,5 @@
|
||||
- 即使不使用 Promise 的返回值,也请使用 await
|
||||
- 路由、Pinia、组件命名规则应符合官方建议
|
||||
- 需要适配深色模式
|
||||
- 所有文字、评论和文档均为中文
|
||||
- 不在没有充分理由的情况下添加外部库
|
||||
- 不用繁重的计算阻塞主线程, 卸载或推迟
|
||||
- 重复 API 调用必要时通过存储进行缓存或协调
|
||||
- 始终显示加载、空和错误状态
|
||||
|
||||
Reference in New Issue
Block a user