 杭州明婳科技
|
ffcb1a77b9
|
docs: 注释/文档一致性审查修复（A/B/C 三档共 23 项）
对 60 个非测试源文件做文档/注释/代码一致性审查，修复 23 项。全部为注释/文档
改动 + 1 处死代码删除，无运行逻辑变更，无 breaking change。
A 档·实质错误（10 项，会误导下游）：
- app.go: closeResources 三连契约注释统一修正--failAfterInit 走
rollbackReplacedResources 不走 closeResources，closeResources 仅供 doShutdown 复用
- database/manager.go: RandomPicker 注释从过时的 rand.Intn/issue 54899 改为 crypto/rand
- model/base.go: datetime(0) 与“亚秒精度”矛盾，改为 datetime(6)
- cache/keybuilder.go: 三处示例下划线分隔符改为冒号（与默认分隔符 : 一致）
- repository/repository.go: Delete 接口注释从绝对“软删除”改为条件性；
UpdateFields 示例移除把字段名当 WHERE 条件的误用写法
- middleware/csrf.go: CSRFToken 注释从“用于 API 模式”改为 Cookie/双重提交模式说明
- examples/full/main.go: POST /users 补上“需 Authorization”标注；删除 _ = app 死代码
- utils/random.go: RandInt/RandInt64 补 min==max 边界说明（对齐 RandIntSecure 写法）
B 档·导出符号注释缺失/不完整（6 项）：
- ws/ws.go: 5 个 Type* 常量、4 个 Err* 变量补注释
- console/console.go: 5 个 Level 常量补注释
- jwt/jwt.go: 2 个 Blacklist 常量补注释
- router/router.go: 包级 GroupWithMiddlewareGroup 补注释
- middleware/ratelimit.go: NewRateLimiter 补 panic 条件与 Stop 生命周期说明
C 档·描述不完整（7 项）：
- utils/strings.go Substr、convert.go CalcPageCount/CalcOffset、datetime.go
StartOfMonth/EndOfMonth、file.go CopyFile、validator.go IsChinese、crypto.go HashFile
补全边界/默认行为/返回值语义
- response/error.go: WithDetail 补 nil 接收者行为说明
验证：go build / go vet / go test -race 全绿。
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
2026-07-12 18:47:12 +08:00 |
|
|
杭州明婳科技
|
4ccbbfbf1b
|
fix full example login password flow
|
2026-07-08 19:36:43 +08:00 |
|
|
杭州明婳科技
|
56352fdd81
|
fix: harden framework lifecycle and middleware safety
|
2026-07-07 00:19:19 +08:00 |
|
|
杭州明婳科技
|
deb3cc71bf
|
feat(v1.0.4): DX & Docs 改进
按报告 v1.0.4 路线图完成 5 项开发体验与文档改进：
#25 模块路径文档改进：
- 保留 -core 后缀（xlgo 是多产品系列：xlgo-core/xlgo-orm/xlgo-ai）
- README 快速开始补完整 import 示例 + 新增「模块路径与包名」小节
- CLAUDE.md Import Path Note 措辞明确化
#27 Without* Option 定位文档化：
- 调研确认 Without* 有真实用例（测试覆盖 + NewFullStack 后排除单项）
- 不删不标 Deprecated，在 app.go 注释 + README 说明其定位
#28 CLI 多模板：
- xlgo new --template minimal/api/fullstack
- minimal 轻量HTTP无依赖，api 标准业务分层（默认），fullstack 全组件
- 三模板实测生成正确
#29 examples/ 目录：
- examples/minimal（50行可跑，无外部依赖）
- examples/full（mysql+redis+jwt+user CRUD）
- examples/README.md
#30 文档结构：
- Version_*.md + report.md 移到 docs/plans/（v2.0-review.md）
- 新增 docs/README.md 索引
- CHANGELOG/GUIDE 留根目录（按惯例）
- .gitignore 整理
build/vet/test + examples 编译全绿。
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
2026-06-22 23:21:59 +08:00 |
|