coding-standards
Installation
SKILL.md
通用编码规范
本技能旨在提供一套通用的编码规范和最佳实践,以提升代码的可读性、可维护性和健壮性。
1. 异常处理 (Exception Handling)
- 避免过度捕获:在开发阶段,尽量不要捕获异常,而是让异常抛出并暴露问题,从而修复潜在的 Bug。
- 精确捕获:永远不要为了方便而捕获顶层异常(如
Exception或Throwable)。只有在确切知道某块代码在特定极端情况下会抛出特定异常,且该异常可以被合理处理时,才去捕获该特定类型的异常。
2. 注释规范 (Comments)
- 自解释代码:代码本身应该是最好的文档。
- 注释功能:如果要加注释,应该优先使用方法、类级别的注释,而不是在方法内写行内注释。