Team’s code standards, current sprint tasks, and plans

Which course does this assignment belong to	EE308
Where are the requirements for this assignment?	Requirement of this project
Team Name	Witness Paradox
Reference documents	CSDN, 《构建之法》
Reference website	click here

1. Roject File Standards:

Naming: Use PascalCase, clear and concise.

Resource Files: Group by type and purpose, like Textures, Models, Scripts.

2. In-Game Naming Conventions:

Variables and Methods: Use camelCase, clear meaning.

Classes and Interfaces: Use PascalCase.

Constants: All uppercase, underscore-separated words.

3. Game Error Standards:

Exception Handling: Use clear error messages.

Error Logs: Include type, location, and potential solutions.

4. Commenting Standards:

Briefly describe code block function.

Detailed explanation for complex logic.

Follow XML documentation standards.

5. Error Logging Standards:

Format: Timestamp, error level, information.

Storage: Organize logs by date.

6. Database Standards:

Naming: Use PascalCase for tables and fields.

Design: Ensure normalization, avoid data duplication.

7. Code Organization:

Layered Architecture: Separate business logic, UI, data access.

Reusability: Write reusable modules and services.

8. Performance Optimization:

Optimize algorithms and data structures.

Avoid unnecessary memory allocation.

9. Security Practices:

Safe coding to prevent injection attacks.

Encrypt sensitive data.

10. Testing:

Unit Testing: Ensure module reliability.

Integration Testing: Verify collaborative part function.

11. Version Control:

Use Git, clear branch strategy.

Clear, accurate commit messages.

12. Code Review:

Regular reviews to improve quality.

Follow team’s best practices.

13. Documentation and Comments:

Detailed API documentation.

Update changelogs.

14. User Interface:

UI component names should reflect their function.

Follow a consistent style guide.