每日 5

代码规范:

  1. 命名规范
    变量/函数/方法:使用有意义的名称,遵循小驼峰或下划线命名。

示例(Python)

user_name = "Alice" # 变量
def calculate_total(): # 函数
类/类型:使用大驼峰(PascalCase)。
// 示例(Java)
public class UserService { ... }
常量:全大写,单词间用下划线分隔。
// 示例(JavaScript)
const MAX_RETRY_COUNT = 3;

  1. 代码结构
    缩进:统一使用空格(推荐 2/4 个空格)或制表符,禁止混用。
    行长度:一般不超过 80-120 字符(根据语言习惯调整)。
    空行:合理使用空行分隔逻辑块,如函数之间、类成员之间。
    模块化:按功能拆分代码,避免单个文件过长(如按组件、服务、工具类拆分)。

  2. 注释规范
    行注释:解释复杂逻辑,而非描述代码本身。

计算用户折扣(VIP 用户享受 8 折)

discount = price * 0.8 if is_vip else price
函数/类注释:说明功能、参数、返回值(可使用文档字符串,如 JSDoc、Python Docstring)。

/**

  • 计算订单总价
  • @param {number[]} prices - 商品价格列表
  • @returns {number} 总价(含税)
    */
    function calculateTotal(prices)
  1. 代码风格
    一致性:团队内统一风格(如大括号位置、换行规则)。
    避免魔法值:用常量代替硬编码的数字或字符串。
    // 错误示例
    if (status == 2)

// 正确示例
final int STATUS_SUCCESS = 2;
if (status == STATUS_SUCCESS) { ... }
单一职责:函数/类只做一件事(参考 SOLID 原则)。

posted @ 2025-03-07 22:01  一如初见233  阅读(24)  评论(0)    收藏  举报