✅ vibe coding rules config

LeoSpud
107 阅读4分钟

✅ vibe coding rules — 中文版

vibe coding rules：统一你的代码质量与工程结构

为了确保团队在 Python 与 Java 开发中保持一致的代码质量、结构、可维护性与可扩展性，本文总结了完整的 vibe coding rules。
这些规则适用于普通项目，也适用于 DDD（领域驱动设计）架构项目，是你的团队未来开发的统一标准。 以下是在antigravity中的使用示例，可适用于trae等ai coding idea。

1. Global 规则（跨语言统一规则）

这些规则适用于所有语言、所有项目：

  1. 所有代码必须遵循该语言的官方格式规范

    • Python → PEP 8
    • Java → Java Code Conventions

  2. 所有代码必须包含充分且清晰的注释：

    • 模块注释
    • 类注释
    • 函数/方法注释
    • 必要的行内注释

  3. 主入口文件只用于展示功能，不允许写业务逻辑：

    • Python → main.py
    • Java → Main.java 或包含 public static void main 的类

  4. 所有业务逻辑必须放在独立模块/类中。

  5. 主入口文件只允许调用示例或演示方法。

  6. 每个功能都必须实现对应的示例方法，用于演示使用方式。

2. code-generation-guide（通用代码生成规范）

（用于提示 AI 自动生成代码时遵循）

  • 生成的代码必须遵循语言官方规范（PEP 8 / Java Code Conventions）。
  • 所有代码必须包含清晰可读的注释与文档。
  • 主入口文件不得实现业务逻辑，只能用于展示功能。
  • 代码功能必须独立在自己的文件、类或模块中实现。
  • 主入口仅用于调用示例方法展示新功能。

3. code-java-ddd-guide（Java + DDD 代码生成规范）

Java 格式规范

  • 使用 4 空格缩进
  • 类采用 PascalCase
  • 方法与变量使用 camelCase
  • 保持合理的空行与空格

注释规范

  • 所有类、方法和关键逻辑必须使用 Javadoc 注释

    包括描述、参数、返回值、示例、注意事项等。

DDD 架构规则

  • 按领域驱动设计（DDD）分层：

    • domain：实体、值对象、聚合根、领域服务
    • application：用例服务、流程编排
    • infrastructure：持久化、消息、第三方接口
    • interface：REST 控制器、CLI、RPC 等

业务逻辑要求

  • 所有业务逻辑必须写在对应 DDD 层中
  • 不能写在 Main.java 中
  • repository 必须用于持久化访问
  • domain service 用于复杂业务规则

示例方法规范

  • 每个功能用例必须有一个示例方法，如：
    exampleOrderCreate()
  • 示例方法应位于 Main.java 或专门的 Runner 中
  • main 方法只负责调用示例方法

4. code-java-guide（普通 Java 项目）

  • main 方法只作为功能入口，不含业务逻辑
  • 每个新功能必须创建独立类
  • 每个新功能必须创建对应示例方法
  • 代码必须遵循 Java Code Conventions
  • 所有类与方法必须有 Javadoc 注释

5. code-python-guide（Python 项目）

  • main.py 的 main() 方法只用于执行示例

  • 不得在 main() 中写业务逻辑

  • 每个新功能必须写在独立模块，例如：

    • feature_x.py

  • 每个功能必须在 main.py 实现对应示例方法：

    • example_feature_x()

  • 所有 Python 文件必须遵循 PEP 8

  • 所有类、方法、模块必须写 docstring（PEP 257）

6. code-style-guide（基础样式规则）

  • 遵循 PEP 8
  • 所有代码必须写注释

7. antigravity doc

global 
1. Make sure all the code is styled with PEP 8 style guide 
2. Make sure all the code is properly commented 
3. All generated code must follow the official style guide of the language (Python uses PEP 8; Java uses standard Java Code Conventions). 
4. All code must include clear and meaningful comments, including module/class/function-level documentation and necessary inline comments. 
5. The main entry point (Python: main.py, Java: Main.java or a class with public static void main) should only be used to showcase functionality, not to contain business logic. 
6. All actual logic must be implemented in separate dedicated files/modules/classes. 
7. The main entry point should only call example or demo methods that showcase new functionality. 
​
code-geration-guide 
* All generated code must follow the official style guide of the language (Python uses PEP 8; Java uses standard Java Code Conventions).
* All code must include clear and meaningful comments, including module/class/function-level documentation and necessary inline comments.
* The main entry point (Python: main.py, Java: Main.java or a class with public static void main) should only be used to showcase functionality, not to contain business logic.
* All actual logic must be implemented in separate dedicated files/modules/classes.
* The main entry point should only call example or demo methods that showcase new functionality.
avatar
文章
阅读
粉丝