SuperAPI AI 工具集

cc-code-layout-and-style

写作与研究

查看项目

更新于 10-16 08:38

技能介绍

用途:依据《Code Complete》的布局与文档检查清单,审查或指导代码的视觉布局与注释质量。核心原则是良好布局应体现程序逻辑结构,一致性优先于具体风格,但一致性须落在研究阈值之内。

主要能力:CHECKER 模式执行清单核查,输出含条目、状态、证据、位置的结果表,严重度分 VIOLATION、WARNING、PASS;APPLIER 模式指导布局决策、注释策略与自文档化技巧。参考阈值包括空行密度 8-16%、缩进 2-4 空格、行长约 80 字符、注释密度约每 10 条语句 1 条(上限而非目标)、每行一条语句。

使用方式:审查类触发词如“review my code formatting”“check code layout”走 CHECKER;指导类如“how should I format this code”“what commenting style”走 APPLIER。APPLIER 流程为建立一致性基线、应用块结构、语句格式、控制结构格式,并按意图过滤级联决定注释去留。

适用场景与限制:适用于人工编写的源码;不适用于自动生成文件、压缩打包产物、第三方 vendored 代码。Go 遵循 gofmt 制表符、Python 遵循 PEP-8/Black,格式化器已处理的样式以其配置为准。所引研究为 1979-2000 年,具体数值属启发式而非验证边界;团队标准若在合理范围内优先。危机场景仅保留每行一条语句、控制结构使用块定界符、至少一条说明原因的注释,并须在部署前创建后续审查工单。