hyp chkcomment.md - maoxiaoyue/hypgo GitHub Wiki
掃描 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 — 修改前分析影響範圍