本文档旨在为开发者提供统一的编码规范建议,遵循 代码质量标准 原则

通用规范 🌐

  • 缩进:使用 4 个空格或 Tab 键保持代码层次清晰
  • 命名:变量名采用 snake_case,常量名使用 UPPER_SNAKE_CASE(⚡️PI = 3.14159
  • 注释:关键逻辑需添加注释,避免冗余说明(📝# 计算BMI指数

语言规范 🧩

Python 🐍

  • 遵循 PEP8 规范
  • 保持每行不超过 79 个字符(⚠️超过时使用反斜杠 \ 换行)
  • 示例:
    def calculate_area(radius):
        return 3.14159 * radius ** 2
    

JavaScript 📱

  • 使用 camelCase 命名变量,PascalCase 命名类(📦const myVariable = 42;
  • 强制使用严格模式(✅'use strict')
  • 示例:
    function formatDate(date) {
        return date.toLocaleString();
    }
    

Java ☕

  • 类名使用 PascalCase,文件名与类名一致(📦public class MyService { ... })
  • 避免在方法名中使用多余参数(🚫void doSomething(String param1, String param2)void doSomething(String data)
  • 示例:
    public class Calculator {
        public int add(int a, int b) {
            return a + b;
        }
    }
    

扩展阅读 📚

代码格式化
命名规范
注释风格