docs: 更新项目要求

This commit is contained in:
AncTe committed 2026-11-09 21:35:33 +08:00
1 parent 53f4bcdee5
commit 73aeb1c005
2 files changed
+5 -1

No files matched your search

+4
View File
@@ -32,6 +32,10 @@
2. **最小抽象、贴着现有结构**:优先直接写和复用现有组件、类型、工具;只有真实重复才抽函数或组件;不造单层包装、通用层和额外间接。组件接收领域输入并在内部派生,调用方不传已算好的展示字段;保持最小 diff。
3. **显式、分区、局部可读**:命名直白,分支直白,布局用容器相对坐标;按“状态 → 派生数据 → 行为 → 渲染/导出”自然展开;长文件用 `//#region` 分组;注释只解释原因、约束或分组,不逐行复述。读者理解一段只需同时记住 2–3 个局部名字。
## 代码要求
代码核心要求:不要求你的代码写的对、不要求测试用例写的多、不要求考虑的边界情况足够多、不要求完全没有类型错误。只要求代码绝对符合 `dev.md` 的要求、代码风格跟已有代码一致,不会看起来不像一个人写的。
## 时间要求
在开始前检查本机账户名,如果是 `LHY`(或小写 `lhy`) 或 `13194`,那么每次子代理执行完毕时,检查本机时间,若时间晚于 22:00,则停止执行,避免 22:30 断电导致内容丢失。按照程序严格度执行此条要求,不到 22:00 就继续,到了再停止,不要因为快到 22:00 就停,差一秒也要继续。
+1 -1
View File
@@ -74,7 +74,7 @@
- 公共方法、接口必须在**源头处**(多数情况下为 `interface`)添加 `jsDoc` 注释;其他常用成员、方法、类型也必须添加注释(含义极为明确或极少使用的可例外,但建议全部添加)。接口中每个方法之间必须添加空行,成员之间应根据成员功能添加换行。
- 继承或 `implements` 而来的 API(方法、成员等),若注释说明无需变更,则**不应重复添加** `jsDoc` 注释。
- 不对构造器添加注释。若构造器使用了属性声明语法(`constructor(public prop: T)`)且成员需要说明,可仅对该成员添加参数注释,不写构造器描述。**在这种情况下**建议避免在构造器中使用属性声明语法,将成员单独声明并在构造器中赋值。此条建议**并非**要求不使用构造器的属性声明语法,而是仅在这一情况下不建议使用,常规情况下推荐使用此语法来缩短代码长度并提高可读性。
- 长文件可使用 `#region` / `#endregion` 分段以支持折叠,分区应以功能进行划分,即这个 region 负责某个功能,而不是按照修饰符等内容划分。
- 长文件可使用 `#region` / `#endregion` 分段以支持折叠,分区应以功能进行划分,即这个 region 负责某个功能,而不是按照修饰符等内容划分。每个分区必须包含足够多的内容,不得几十行就分一个段,每个分段内容必须完备,包含完整的功能集合,不得一个函数就分一个段,分段粒度不能过细。短文件不得分段。
- TODO 使用 `// TODO:` 或 `// todo:` 格式。
- 单行注释的 `//` 与注释内容之间留一个空格;不允许出现非 jsDoc 的多行注释,如需多行注释,使用多个单行注释代替。
- 注释合理换行:考虑中文字符较宽,建议每 40–60 个字符在标点符号后换行,不要频繁换行,每行长度应差不多,不要过短也不要过长,不允许在句中换行;参数注释换行后保持对齐。