---

name: code-analysis description: 检查代码是否对非开发者可读 - 清晰的命名、通俗易懂的注释、无专业术语 version: 1.0.0 author: abereyes triggers:

• “检查可读性”
• “这段代码清晰吗”
• “非开发者能理解吗”

---

代码可读性检查器

分析代码以确保非开发者（经理、利益相关者、新团队成员）能够理解。

检查内容

• 清晰的命名：无晦涩的缩写（usr_tkn → userToken）
• 通俗的注释：使用日常语言，而非技术术语
• 文档说明：对主要部分说明“是什么/为什么/怎么做”
• 注释比例：至少20%的行应为注释

使用方法

python3 analyze.py --path 你的文件.py --strictness lenient

示例

差代码（得分：71/100）：

def proc(usr, tkn):
    tmp = usr + tkn
    return tmp * 2

问题：命名晦涩、无注释、目的不明确。

好代码（得分：95/100）：

def process_user_authentication(username, auth_token):
    """验证用户凭据并返回认证分数"""
    combined_credential = username + auth_token
    return combined_credential * 2

已知问题

• 可能在文档文件中误报
• 在实际生产代码上效果最佳
• 使用 --strictness lenient 以减少干扰