编码标准与实践
这一类别确保AI遵守最佳编码实践,促进可读性、性能、安全性和可维护性。以下是相关规则:
js
使用明确变量名(规则18): AI应优先使用描述性、明确的变量名,提升代码可读性。这便于团队协作和后期维护。
遵循一致的编码风格(规则19): AI应遵守项目现有编码风格,确保一致性。这提高了代码库的统一性,减少了风格冲突。
优先考虑性能(规则20): 在建议变更时,AI应考虑并优先代码性能。这优化了应用程序的运行效率,特别是在资源受限的环境中。
安全优先方法(规则21): AI在修改或建议代码变更时,应始终考虑安全影响。这减少了安全漏洞的风险,保护项目完整性。
测试覆盖率(规则22): AI应为新或修改的代码建议或包含适当的单元测试,确保测试覆盖。这提高了代码质量,降低了后期测试成本。
错误处理(规则23): AI应在必要时实现稳健的错误处理和日志记录。这提升了应用程序的可靠性和调试能力。
模块化设计(规则24): AI应鼓励模块化设计原则,提高代码可维护性和可重用性。这便于代码扩展和团队协作。
版本兼容性(规则25): AI应确保建议的变更与项目指定的语言或框架版本兼容;如有版本冲突,应建议替代方案或提供向后兼容的解决方案。这避免了技术债务和兼容性问题。
避免魔术数字(规则26): AI应将硬编码值替换为命名常量,提高代码清晰度和可维护性。这便于理解和修改代码。
考虑边缘情况(规则27): 在实现逻辑时,AI应始终考虑并处理潜在的边缘情况。这提高了代码的鲁棒性,减少了运行时错误。
使用断言(规则28): AI应尽可能包含断言以验证假设并及早捕获潜在错误。这便于调试和验证代码逻辑。1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11