果园编程工作室代码规范协议

为了确保我们的项目高效、有序地进行，并保持代码的可读性和可维护性，特此制定《果园编程工作室代码规范协议》。本协议适用于所有使用Scratch、Python、HTML等编程语言的项目开发，同时也鼓励在其他编程语言中遵循这些基本原则。

1. 通用规则

• 代码格式化：所有代码应保持良好的格式化，包括但不限于适当的缩进、空格、换行等，以提高代码的可读性。
• 命名规范：变量、函数、类等命名应具有描述性，避免使用单个字母或无意义的数字作为名称。具体根据所使用的编程语言惯例而定。
• 版本号要求格式必须为：X.Y.Z。主版号（X）不向下兼容，次版号（Y）新增特性，修订版号（Z）修复问题，必要时用希腊字母标识特殊版本（如：2.4.3，表示第2个大版本，第4次新增特性，修复了3次BUG）。
• 注释要求：对于超过100行的代码块，必须添加注释说明其功能、参数、返回值等信息。即使是短小的代码片段，如果逻辑复杂，也应适当添加注释。
• 错误处理：所有可能抛出异常的操作都应有相应的错误处理机制，确保程序的健壮性。
• 版本控制：使用Git或其他版本控制系统管理代码，每次提交前需确保代码已通过测试且符合规范。
• 异常处理：小问题发现时，先保存副本并自行修改；若无法修复，请在QQ群内提问。大问题请直接联系果园。
• 大更新保存副本：对项目进行大更新时，要先保存副本，以防引入BUG。

2. 特定语言指南

Scratch

• 初始化设置：每个项目开始时，应当设置舞台背景和角色的初始位置（例如，绿旗点击后，X=0, Y=0）。此外，还应初始化角色的状态，如大小、方向等。
• 脚本组织：利用事件积木合理组织脚本，确保逻辑清晰。尽量避免过长的脚本链，可以考虑将重复的功能封装成自定义积木。
• 数据管理：合理使用变量和列表来存储和处理数据，注意变量的作用域，区分全局与局部变量。

Python及其他代码编程语言

• 导入声明：所有外部库的导入应放在文件顶部，按标准库、第三方库、本地模块的顺序依次排列，每组之间空一行。对于第三方库，在导入时应添加注释，指示如何安装该库，例如 import pandas as pd # pip install pandas。
• 函数定义：每个函数前应有docstring简要描述函数目的、参数及返回值。
• 类设计：遵循单一职责原则，每个类只负责一个功能点。

HTML

• 文档结构：确保HTML文档结构正确，包括DOCTYPE声明、html标签、head标签和body标签。
• 语义化标签：尽可能使用语义化的HTML5标签，如<article>、<section>、<header>等，以增强页面的可访问性和SEO。

3. 多人协作规则

• 避免冲突：工作在同一文件上的成员应协调好时间，避免同时修改同一段代码造成冲突。使用分支管理各自的工作，合并时仔细检查差异。

4. 结语

以上为果园编程工作室的基本代码规范，随着项目的推进和技术的发展，本规范也会适时调整和完善。我们鼓励每位成员提出宝贵的意见和建议，共同促进团队的成长和发展。