-
Notifications
You must be signed in to change notification settings - Fork 0
hyp chkcomment.md
maoxiaoyue edited this page Apr 14, 2026
·
1 revision
掃描 Go 原始碼檔案,檢查所有 exported 區塊是否有標準文檔註解。
hyp chkcomment <file.go> # 檢查並報告 hyp chkcomment --fix <file.go> # 自動加入建議註解
| Flag | 說明 |
|---|---|
--fix |
自動加入建議註解(建立 .bak 備份) |
| 類型 | 範例 |
|---|---|
| Package | package controllers |
| Type | type UserController struct |
| Func | func CreateUser(...) |
| Method | func (ctrl *UserController) Create(...) |
| Const | const MaxItems = 100 |
| Var | var ErrNotFound = ... |
Comment Check: controllers/user.go
✅ package controllers
✅ type UserController
❌ func Create — missing comment
Suggested: // Create handles the creation of User
❌ func Delete — missing comment
Suggested: // Delete handles the deletion of User
Result: 2/4 blocks have comments (50%)
檢查器識別 @ai: 標註:
// @ai:constraint max_items=100 // @ai:deprecated use V2 instead // @ai:security requires_auth // @ai:impact routes=/api/users // @ai:owner team=backend
- 純 AST 分析,不執行程式碼
- 只接受
.go檔案,拒絕符號連結 -
--fix先建立.bak備份再修改
- hyp impact — 修改前分析影響範圍
設計文件
套件
- config — 設定
- context — 請求上下文
- router — 路由器
- server — 伺服器
- middleware — 中介層
- websocket — WebSocket
- hidb — 資料庫 ORM
- hidb/cassandra — Cassandra
- logger — 日誌
- json — JSON 處理
- grpc — gRPC
AI 協作工具鏈
- schema — Schema-first 路由
- manifest — 專案 Manifest
- contract — Contract Testing
- errors — Typed Error Catalog
- migrate — Migration Diff
- scaffold — 智慧 Scaffold
- airules — AI Rules
CLI 命令
- hyp 總覽
- hyp new
- hyp api
- hyp run
- hyp restart
- hyp generate
- hyp migrate
- hyp context
- hyp ai-rules
- hyp chkcomment
- hyp impact
- hyp docker
- hyp health
- hyp version
- hyp difflog
Design Docs
Packages
- config — Configuration
- context — Request Context
- router — Router
- server — Server
- middleware — Middleware
- websocket — WebSocket
- hidb — Database ORM
- hidb/cassandra - Cassandra 5.0
- logger — Logger
- json — JSON
- grpc — gRPC
AI Collaboration Toolchain
- schema — Schema-first Routing
- manifest — Project Manifest
- contract — Contract Testing
- errors — Typed Error Catalog
- migrate — Migration Diff
- scaffold — Smart Scaffold
- airules — AI Rules
CLI Commands