编辑“︁代码风格与规范”︁（章节）

= 代码风格与规范 =

== 介绍 ==
'''代码风格与规范'''（Code Style and Conventions）是编程中一组约定俗成的规则，用于统一代码的书写格式、命名方式、注释风格等。良好的代码风格不仅能提高代码的可读性，还能减少团队协作中的沟通成本，尤其在'''算法竞赛'''和'''技术面试'''中，清晰的代码风格能帮助评审者快速理解解题思路。

代码规范通常包含以下方面：
* 缩进与空格的使用
* 变量与函数的命名规则
* 注释的写法
* 代码结构的组织方式
* 语言特有的惯例（如Python的PEP 8）

== 为什么代码风格重要？ ==
在算法竞赛和面试中，代码风格的重要性体现在：
# '''可读性'''：清晰的代码能让评委或面试官快速理解逻辑。
# '''维护性'''：规范的代码便于后续调试或修改。
# '''专业性'''：体现程序员的职业素养。

=== 实际场景对比 ===
<syntaxhighlight lang="python">
# 不规范示例
def f(a,b):
    c=a+b
    return c

# 规范示例 (PEP 8)
def calculate_sum(num1, num2):
    """Return the sum of two numbers."""
    result = num1 + num2
    return result
</syntaxhighlight>

== 通用规范 ==

=== 1. 命名约定 ===
{| class="wikitable"
|+ 常见命名风格对比
! 类型 !! 示例 !! 适用语言
|-
| 小驼峰 | <code>userCount</code> | Java/JavaScript
|-
| 大驼峰 | <code>UserCount</code> | Python/C# 
|-
| 蛇形 | <code>user_count</code> | Python/Ruby
|-
| 全大写 | <code>MAX_SIZE</code> | 常量通用
|}

=== 2. 缩进与空格 ===
* 使用4个空格（Python）或2个空格（JavaScript）作为缩进
* 运算符两侧加空格：<code>x = y + z</code>
* 避免行尾空格

=== 3. 注释规范 ===
* 函数注释（Docstring）：
<syntaxhighlight lang="python">
def binary_search(arr, target):
    """
    Perform binary search on a sorted array.
    
    Args:
        arr: List[int], sorted input array
        target: int, value to search for
    
    Returns:
        int: Index of target if found, else -1
    """
    left, right = 0, len(arr) - 1
    ...
</syntaxhighlight>

== 语言特定规范 ==

=== Python (PEP 8) ===
* 模块/包名：全小写+下划线（<code>data_processor</code>）
* 类名：大驼峰（<code>ClassName</code>）
* 函数/变量：蛇形（<code>function_name</code>）

=== Java ===
* 类名：大驼峰
* 方法名：小驼峰
* 常量：全大写+下划线

== 竞赛/面试专用技巧 ==

=== 1. 快速输入输出 ===
在算法竞赛中，规范的IO处理能节省时间：
<syntaxhighlight lang="cpp">
// C++ 快速IO
ios::sync_with_stdio(false);
cin.tie(nullptr);
</syntaxhighlight>

=== 2. 代码分段 ===
用空行分隔逻辑块：
<syntaxhighlight lang="java">
// 输入处理
Scanner sc = new Scanner(System.in);
int n = sc.nextInt();

// 核心算法
int result = 0;
for (int i = 0; i < n; i++) {
    result += i * 2;
}

// 输出结果
System.out.println(result);
</syntaxhighlight>

== 可视化案例 ==
<mermaid>
flowchart TD
    A[开始] --> B{输入验证}
    B -->|有效| C[算法处理]
    B -->|无效| D[错误处理]
    C --> E[结果输出]
    D --> E
</mermaid>

== 数学公式规范 ==
当需要描述算法复杂度时：
* 时间复杂度：<math>O(n \log n)</math>
* 空间复杂度：<math>O(1)</math>

== 常见错误 ==
* '''过度缩写'''：<code>tmp</code> 比 <code>t</code> 更明确
* '''魔法数字'''：用常量代替直接数值
<syntaxhighlight lang="python">
# 不推荐
if status == 1: ...

# 推荐
ACTIVE_STATUS = 1
if status == ACTIVE_STATUS: ...
</syntaxhighlight>

== 总结 ==
良好的代码风格是程序员的基本素养，特别是在高压的竞赛和面试环境中。建议：
* 学习主流语言的官方风格指南
* 使用Lint工具（如ESLint/Flake8）
* 在写代码时保持一致性

[[Category:计算机科学]]
[[Category:数据结构与算法]]
[[Category:算法竞赛与面试]]