代码编写规范文档.docxVIP

代码编写规范精选文档

代码编写规范的核心目标是保证代码的可读性、可维护性、可复用性和一致性，降低团队协作成本与后期维护成本，同时提升代码质量、减少Bug产生。本文档精选通用规范与主流编程语言核心规范，兼顾通用性与实用性，适用于个人开发及团队协作场景，可直接落地执行。

一、通用核心规范（全语言适用）

1.1命名规范（基础且核心）

命名的核心原则是“见名知意”，禁用拼音、无意义缩写（通用缩写如id、URL、API除外），统一命名风格，避免大小写混乱，具体要求如下：

变量/函数：采用小驼峰命名法（camelCase），如userName、calculateTotalAmount，避免单个字母（如a、b）或模糊命名（如data1、temp）。

常量：采用全大写+下划线分隔（UPPER_SNAKE_CASE），如MAX_CONNECTIONS、API_TIMEOUT，明确常量含义，避免魔法数字/字符串硬编码。

类/结构体：采用大驼峰命名法（PascalCase），如DatabaseConnection、UserService，类名需体现其核心职责。

私有成员：前缀加下划线（_xxx），如_privateMethod、_connection，区分公共与私有成员，避免访问冲突。

文件/目录：前端优先采用小写+连字符（kebab-case），如user-service.js；后端可采用小写+下