关于 implementing-code
面向编写和审查代码的开发者,提供实现流程与检查清单,覆盖安全、性能、可读性和测试。还建议通过本地测试及代码检查反复验证修改。
主要功能
- 01检查注入、认证与敏感数据风险
- 02检查查询效率和内存问题
- 03审视 SOLID、命名与注释
- 04覆盖边界、错误及正常路径测试
- 05按测试与格式检查结果迭代
适用场景
- 01实现功能或修复缺陷时检查质量
- 02审查外部输入验证与错误处理
- 03发现 N+1 查询和潜在内存泄漏
- 04制定代码审查与测试清单
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ dralgorhythm/ claude-agentic-framework --skill implementing-code安装后在 Claude Code 中输入/implementing-code确认已加载。
详细介绍
代码实现
工作流
- 安全检查:注入漏洞、身份验证问题、敏感数据泄露
- 性能检查:N+1 查询、内存泄漏、低效算法
- 可读性检查:SOLID 原则、命名规范、注释
- 测试检查:边缘情况、错误路径、正常路径
反馈循环
- 实现功能或修复问题
- 运行本地测试(单元测试/集成测试)
- 运行代码检查工具/格式化工具
- 如果失败,修复后重试
参考实现
符合 SOLID 原则的类(TypeScript)
// Abstraction (Interface Segregation)
interface ILogger {
log(message: string): void;
}
interface IUserRepository {
save(user: User): Promise<void>;
}
// Domain Entity
class User {
constructor(public readonly id: string, public readonly email: string) {}
}
// Implementation (Single Responsibility)
class UserService {
constructor(
private readonly userRepository: IUserRepository,
private readonly logger: ILogger
) {}
public async registerUser(email: string): Promise<User> {
if (!email.includes('@')) {
throw new Error("Invalid email format");
}
const user = new User(crypto.randomUUID(), email);
await this.userRepository.save(user);
this.logger.log(`User registered: ${user.id}`);
return user;
}
}
代码审查清单
- 没有硬编码的密钥或凭据
- 对所有外部数据进行输入验证
- 使用有意义的消息妥善处理错误
- 没有 N+1 查询模式
- 函数遵循单一职责原则
- 通过依赖注入提供依赖项,而非在行内实例化
- 测试覆盖正常路径和边缘情况
评论
支持 Markdown