Welcome to our Code Style Guide! This document outlines the conventions and best practices for writing clean, readable, and maintainable code across our projects. Whether you're a seasoned developer or just starting out, following these guidelines will help ensure consistency and improve the overall quality of our codebase.

Language-Specific Guidelines

Our codebase supports multiple programming languages, each with its own set of style conventions. Below are some general guidelines for each language:

English (en)

  • Indentation: Use 4 spaces per indentation level.
  • Line Length: Keep lines to a maximum of 80 characters.
  • Comments: Use meaningful comments to explain the purpose of code blocks.
  • Naming Conventions: Use clear, descriptive names for variables, functions, and classes.
  • Code Formatting: Use tools like Prettier to automatically format your code.
  • Documentation: Ensure that all public-facing functions and classes have appropriate documentation comments.

For more detailed information, please refer to our English Code Style Guide.

中文 (zh)

  • 缩进: 每个缩进级别使用4个空格。
  • 行长度: 保持行长度不超过80个字符。
  • 注释: 使用有意义的注释来解释代码块的目的。
  • 命名规范: 使用清晰、描述性的名称为变量、函数和类命名。
  • 代码格式化: 使用Prettier等工具自动格式化代码。
  • 文档: 确保所有面向公众的函数和类都有适当的文档注释。

更多详细信息，请参阅我们的中文代码风格指南。

Best Practices

  • Version Control: Always use version control systems like Git to manage your code.
  • Code Reviews: Regularly review each other's code to catch potential issues and share knowledge.
  • Testing: Write comprehensive tests for your code to ensure its correctness and reliability.
  • Refactoring: Continuously refactor your code to improve its structure and readability.
  • Continuous Integration: Implement continuous integration to automate the testing and deployment process.

By following these guidelines and best practices, we can create a high-quality codebase that is easy to maintain and scale.

Code Style Best Practices

For more information on best practices, check out our Best Practices Guide.