你定义的 AI 编码规则是什么?全网寻找通义灵码 Rules {头号玩家}!
1. 项目结构
模块化设计:将不同功能模块分离,如 AGENT、后台、MCP 模块,以实现模块解耦和可维护性。组件等,每个模块有独立的目录和文件结构。分层架构:采用分层架构,如表现层、业务逻辑层、数据访问层等,确保各层职责清晰。
2. 命名规范
变量和函数命名:使用有意义的英文单词或缩写,采用驼峰命名法(CamelCase)。例如:userInfo、getProductList。类命名:使用大驼峰命名法(PascalCase),例如:UserService、ProductController。常量命名:使用全大写字母,单词之间用下划线分隔,例如:MAX_ATTEMPTS、DEFAULT_TIMEOUT。
3. 代码注释
文件注释:在每个文件开头添加注释,说明文件的功能、作者、创建时间等信息。
# 文件名: user_service.py
# 功能: 处理用户相关业务逻辑
# 作者: [你的名字]
# 创建时间: [具体时间]
函数和类注释:在函数和类定义前添加注释,说明其功能、参数和返回值。
def get_user_info(user_id):
根据用户 ID 获取用户信息
:param user_id: 用户 ID
:return: 用户信息字典
# 函数实现代码
pass
关键代码注释:在关键代码处添加注释,解释代码的意图和实现思路。
4. 错误处理
异常捕获:在可能出现异常的代码块中使用 try-except 语句捕获异常,并进行适当的处理。
try:
# 可能出现异常的代码
result = some_function()
except Exception as e:
# 异常处理代码
print(f'发生异常: {e}')
错误日志记录:使用日志记录工具(如 Python 的 logging 模块)记录错误信息,方便后续排查问题。
5. 数据传递和调用
数据格式:统一数据传递的格式,如 JSON 或 XML。接口设计:定义清晰的接口,确保客户端和服务端之间的数据传递和调用规范。安全性:在数据传递过程中,注意数据的加密和验证,防止数据泄露和恶意攻击。
6. 跨平台兼容性
操作系统差异处理:在代码中考虑 Windows 和 Linux 操作系统的差异,使用跨平台的库和方法。文件路径处理:使用 os.path 模块处理文件路径,避免硬编码文件路径。
7. 与其他 AI 大模型集成
接口规范:定义与其他 AI 大模型的接口规范,确保数据传递和调用的一致性。异步处理:对于耗时的 AI 模型调用,使用异步处理方式,避免阻塞主线程。
8. 代码测试
单元测试:为每个功能模块编写单元测试,确保代码的正确性。集成测试:进行集成测试,验证不同模块之间的协作是否正常。
9. 版本控制
使用 Git:使用 Git 进行版本控制,定期提交代码,方便团队协作和代码管理。分支管理:采用合适的分支管理策略,如 GitFlow 或 GitHub Flow。
10. 代码审查
定期审查:定期进行代码审查,确保代码符合编码规则和最佳实践。反馈和改进:对代码审查中发现的问题及时反馈,并进行改进。
以上编码规则仅供参考,你可以根据具体项目需求进行调整和完善。
赞123
踩0