代码质量规范助手,覆盖编码风格、安全合规、无障碍访问标准,适用于代码编写、审查及UI开发场景,确保可维护性与安全性。
基本信息
- 技能名称?Code Quality
- 中文名称?代码规范·安全合规·无障碍标准一站式指南
- 作者?urbantech
- 分类?其他
- 版本?1.0.0
- 标签?code-quality, security, accessibility, coding-standards, wcag, code-review, best-practices, compliance
使用方法
使用说明
核心用法
code-quality 技能为开发团队提供统一的代码质量规范,主要应用于五大场景:新代码编写、代码风格与安全审查、UI/UX功能实现、安全问题处理、无障碍合规检查。
编码风格方面 ,该技能确立了明确的命名约定(camelCase变量/函数、PascalCase类/类型)、4空格缩进格式、80字符行宽限制,以及有意义的注释规范,强调及时清理过时注释以保持代码可维护性。
安全合规层面 ,核心原则包括:绝不记录密钥/个人身份信息(PII)、严格输入验证、默认最小权限原则。错误处理要求显式错误类型、结构化日志分级,确保消息可操作。
无障碍与UX质量 要求优先使用语义化角色与标签,键盘导航和焦点顺序必须可用,并规定在375、768、1024、1440四个断点进行响应式检查。测试建议使用确定性ID,避免脆弱的CSS/XPath选择器。
安全合规 guardrails 明确禁止在代码、测试或截图中使用真实凭证,强制使用测试账户/夹具并脱敏处理敏感信息。PR中需文档化威胁考量。
显著优点
- 覆盖面完整 :将编码风格、安全、无障碍三大质量维度整合为单一技能
- 可操作性强 :提供具体数值标准(行宽80字符、四个响应式断点)和明确禁用项
- 安全优先设计 :从代码编写源头嵌入安全思维,而非事后检查
- 无障碍内置 :将WCAG合规要求前置到开发流程,降低合规成本
潜在局限
未指定具体技术栈(Java/ Python/ Node.js等),团队需自行映射到语言特定规范
80字符行宽在现代宽屏环境中可能存在争议
依赖外部参考文件( references/ 目录),实际可用性取决于文件维护状态
适合人群
前端/全栈开发者、代码审查者、安全合规专员、需要满足WCAG无障碍要求的产品团队,以及建立代码规范的新团队或重构项目。
常规风险
规范执行依赖人工审查,缺乏自动化检测集成说明
"有意义注释"等主观标准可能引发团队解读分歧
四个断点覆盖可能不足以应对特定设备生态(如折叠屏、超宽屏)
💬 评论 (0)
📭 还没有评论,快来抢沙发吧!