Update READMEs and add new English prompt files and translation maps.

This commit is contained in:
tukuaiai
2025-12-16 23:21:17 +08:00
parent 9f7cf53b39
commit bf44b87a07
12 changed files with 607 additions and 262 deletions
@@ -1,46 +1,45 @@
TRANSLATED CONTENT:
# 代码组织
# Code Organization
## 模块化编程
## Modular Programming
- 将代码分割成小的、可重用的模块或函数,每个模块负责只做一件事。
- 使用明确的模块结构和目录结构来组织代码,使代码更易于导航。
- Split code into small, reusable modules or functions, with each module responsible for doing only one thing.
- Use a clear module and directory structure to organize code, making it easier to navigate.
## 命名规范
## Naming Conventions
- 使用有意义且一致的命名规范,以便从名称就能理解变量、函数、类的作用。
- 遵循命名约定,如驼峰命名(CamelCase)用于类名,蛇形命名(snake_case)用于函数名和变量名。
- Use meaningful and consistent naming conventions so that the purpose of variables, functions, and classes can be understood from their names.
- Follow naming conventions, such as CamelCase for class names and snake_case for function and variable names.
## 代码注释
## Code Comments
- 为复杂的代码段添加注释,解释代码的功能和逻辑。
- 使用块注释(/*...*/)和行注释(//)来区分不同类型的注释。
- Add comments to complex code segments to explain the code's functionality and logic.
- Use block comments (/*...*/) and line comments (//) to distinguish different types of comments.
## 代码格式化
## Code Formatting
- 使用一致的代码风格和格式化规则,使用工具如 Prettier Black 自动格式化代码。
- 使用空行、缩进和空格来增加代码的可读性。
- Use consistent code style and formatting rules, and automatically format code with tools like Prettier or Black.
- Use blank lines, indentation, and spaces to improve code readability.
# 文档
# Documentation
## 文档字符串
## Docstrings
- 在每个模块、类和函数的开头使用文档字符串,解释其用途、参数和返回值。
- 选择一致的文档字符串格式,如 Google StyleNumPy/SciPy Style Sphinx Style
- Use docstrings at the beginning of each module, class, and function to explain its purpose, parameters, and return values.
- Choose a consistent docstring format, such as Google Style, NumPy/SciPy Style or Sphinx Style.
## 自动化文档生成
## Automated Documentation Generation
- 使用工具如 SphinxDoxygen JSDoc 从代码中自动生成文档。
- 保持文档和代码同步,确保文档始终是最新的。
- Use tools like Sphinx, Doxygen or JSDoc to automatically generate documentation from code.
- Keep documentation and code synchronized to ensure documentation is always up-to-date.
## README 文件
## README File
- 在每个项目的根目录中包含一个详细的 README 文件,解释项目目的、安装步骤、用法和示例。
- 使用 Markdown 语法编写 README 文件,使其易于阅读和维护。
- Include a detailed README file in the root directory of each project, explaining the project's purpose, installation steps, usage, and examples.
- Write README files using Markdown syntax to make them easy to read and maintain.
# 工具
# Tools
## IDE
- 使用功能强大的 IDE,如 Visual Studio CodePyCharm IntelliJ,利用其代码自动补全、错误检查和调试功能。
- 配置 IDE 插件,如 linter(如 ESLintPylint)和代码格式化工具。
- Use powerful IDEs such as Visual Studio Code, PyCharm or IntelliJ, leveraging their code autocomplete, error checking, and debugging features.
- Configure IDE plugins, such as linters (e.g., ESLint, Pylint) and code formatters.