蒟蒻 AstralNahida 的码风

第零部 · 写在前面的碎碎念

第一章 · 前言

这里是蒟蒻 OIer AstralNahida 在 OI 中的码风的详细介绍。
个人认为码风相当清晰，供给各位参考。
第二章 · 约定

对于一些表示必要性的关键词，从 must 到 mustn't 排序如下：

必须 > 尽量 > 应当 > 建议 > 可以 > 不建议 > 不应当 > 尽量不 > 不得。

为方便阅读，本文中所有上述关键词都用粗体字表示。
另外，若没有「至少」、「至多」等词的限定，所有的数字默认为严格的。
例如「中间有一个空行」中的「有一个」默认为「有且仅有一个」。
第一部 · 整体

这里贴一份本人做洛谷 P2330 的代码：

1. #include <iostream>
2. #include
4. #define fasterIO std::ios::sync_with_stdio(false), std::cin.tie(nullptr), std::cout.tie(nullptr)
6. #define Nahida return 0
8. struct Edge {
9.         int vtx1, vtx2, wgt;
10. } edge[200005];
11. bool operator<(const Edge& edge1, const Edge& edge2) {
12.         return edge1.wgt < edge2.wgt;
13. }
15. int rt[5005];
16. int findRt(int node) {
17.         return rt[node] == node ? node : rt[node] = findRt(rt[node]);
18. }
20. int n, m;
22. void Kruskal(void) {
23.         int ans = 0, edgeNum = 0;
24.         std::sort(edge + 1, edge + m + 1);
26.         int rt1, rt2;
27.         for (int i = 1; i <= m; i++) {
28.                 rt1 = findRt(edge[i].vtx1); rt2 = findRt(edge[i].vtx2);
29.                 if (rt1 == rt2) {
30.                         continue;
31.                 }
32.                 ans = std::max(edge[i].wgt, ans);
33.                 rt[rt2] = rt1;
34.                 if (++edgeNum == n - 1) {
35.                         break;
36.                 }
37.         }
39.         std::cout << edgeNum << ' ' << ans << '\n';
41.         return;
42. }
44. int main(void) {
45.         fasterIO;
46.        
47.         std::cin >> n >> m;
48.         for (int i = 1; i <= n; i++) {
49.                 rt[i] = i;
50.         }
51.         for (int i = 1; i <= m; i++) {
52.                 std::cin >> edge[i].vtx1 >> edge[i].vtx2 >> edge[i].wgt;
53.         }
55.         Kruskal();
56.        
57.         Nahida;
58. }

复制代码

大概是这样式的。
由此可以看出，我的代码大致分为四个部分：

• #include 部分，用于包含代码所需的头文件；
  
• #define 部分，用于进行一些简化代码的宏定义以及自己的一些小癖好（如 Line 6 的 #define Nahida return 0）；
  
• 全局变量、常量及函数的声明及定义部分；
  
• 主函数部分。
  

这一部只是提供代码的整体观感而已，码风具体规则详见下文。
第二部 · 头文件包含及宏定义

第一章 · 头文件

对于任意项目，在写代码的时候不得使用万能头 。除了刷题的时候可以少点时间，其它全是缺点。
对于引用的头文件，C 标准的头文件应当使用以 c 为前缀的形式，而非 .h 为后缀的形式。
例如， 应当写成 。
对于所有头文件，建议将 C 标准的头文件放在一起，后必须接一个空行再把 C++ 的头文件包含进来。
另外，也建议以头文件的作用将包含的头文件分类，每个类别中间必须由一个空行分割。
上述两种分段方式任选其一即可。
另外，不得使用 using namespace std;，否则函数名、变量名容易出现冲突。
必要时，可以使用 using std::sort; 此类方法，但仍需要确定函数名、变量名不出现冲突。
第二章 · 宏定义

对于任意宏定义，其作用为下列两种的任意一种：1° 简化代码或定义常量；2° 满足自己的小癖好。
如果一份代码中同时出现了这两种宏定义，则需要把两种宏定义分别放在一起，中间必须由一个空行分隔。
第三部 · 缩进及大括号

第一章 · 缩进

必须使用 4 空格缩进。
在每一个大括号的内部或者 case、public、private 等的内部，必须使用一份缩进。
对于很长的表达式，需要分行来确保可读性和可维护性时，也必须使用一份缩进。
任意 # 开头的指令之前不得使用缩进，无论它是否在原本需要使用缩进的块内。
第二章 · 大括号

大括号的常用风格有以下两种：

• 「通透」风格：
  

1. if (1 + 1 == 2)
2. {
3.     break;
4. }

复制代码

• 「饱满」风格：
  

1. if (1 + 1 == 2) {
2.     break;
3. }

复制代码

必须使用这两种中的任意一种，且不得混用。
这里更建议使用第二种，否则若内部的语句很少，整个代码观感就比较空虚。
第四部 · 空格及空行

第一章 · 空格

必须妥善利用空格，否则代码过于紧凑（说难听点，挤成一坨），影响观感和可读性、可维护性。
以下列出的位置必须使用一个空格：

• 双目运算符的左右两侧（特殊地，+ 和 - 作为正负号时，与后接的表达式之间不得使用空格）；
  
• 流运算符的左右两侧；
  
• if 系列、while 和 do-while、switch、for 和 foreach 等与后接的（或前导的）大括号或小括号之间；
  
• 一对大括号在同一行时，左大括号的后面和右大括号的前面；
  
• 三目运算符中，? 和 : 的左右两侧；
  
• * 表示指针类型时，若后接变量名，与变量名之间；
  
• #include 与后接的  之间；
  
• 使用「饱满」风格的大括号时，左大括号与前导内容之间；
  
• , 或 ; 与后接的表达式之间；
  
• 其它必须使用空格的地方。
  

任何除了作为缩进以外的地方，都不得出现几个空格连用的情况。
以下列出的位置不得使用空格：

• ::、->、. 的左右两侧；
  
• * 表示指针所引用的内容时，与后接变量名之间；
  
• * 表示指针类型时，与前导的类型名之间；
  
• 函数名与后接小括号之间；
  
• , 或 ; 的左侧；
  
• 单目运算符与参与运算的表达式之间；
  
• + 和 - 作为正负号时，与后接的表达式之间；
  
• 其它不得使用空格的地方。
  

第二章 · 空行

必须妥善利用空行，否则代码过于紧凑（说难听点，挤成一坨），影响观感和可读性、可维护性。
在第一部中提到，代码大致分成四个部分，其中每个部分之间必须使用一个空行。
在其它的任何位置，应当根据代码内容合理地使用一个空行进行分隔，确保代码可读性、可维护性。
第五部 · 变量、常量及函数

第一章 · 定义

若非必要，尽量不定义全局变量。
定义常量，必须使用 #define 或 const 中的任意一种，不得混用。
其它函数必须在主函数之前声明并定义。
第二章 · 命名

命名尽量不过长，否则使用没有自动补全的编辑器时容易累死，表达式也容易过长，影响观感和可读性、可维护性。
同时，命名不得使用过于简单、没有意义的名字，尽量在命名中体现出该函数的作用。题目所给出的变量名除外。
需要注意的是，「过于简单、没有意义」的核心是「没有意义」，若单个字母有明显意义的，不算作不规范命名，如 for 中的 i、表示顶点的 u、v 等。
当然，变量较多时，确实不建议使用单个字母命名。
第 \(\inf\) 部 · 写在后面的碎碎念

第一章 · 后记

差不多就是这样了。我这里给出的码风规范其实是相对宽松的，有很多自由的空间。
有些人可能会问，码风真的有这么重要吗？
当然有的。上面我也提到了不少次，养成好的码风究其根本是为了保证代码的可读性和可维护性，同时保证代码美观。
好的码风对于 OIer 来说无疑是极其重要的，正所谓「码如其人」，如果你是一个有追求的 OIer，那么你应当拥有一个整洁、统一的码风。
当然，如果你决定将来做程序设计工作或现在正在做程序设计工作，你也应当养成好的码风，否则项目迟早被写成屎山。
好啦，就到这里吧，祝各位热爱自己的 OI 生涯。
第二章 · 声明

本文欢迎广大 OIer 转载，同时，转载者必须注明出处并附上原文链接，谢谢配合！
若有需要补充的地方，欢迎大家指出，谢谢！
第 \(\mathrm i\) 部 · 更新记录

• 2025/04/26 14:09 本文正式告成，发布。
  
• 2025/04/27 17:43 微调语言描述。
  
• 2025/05/05 06:24 微调语言描述。
  
• 2025/05/05 08:55 更换第一部中的示例代码。
  
• 2025/05/27 21:55 将第一部中示例代码的 uF(i, a, b, x) 和 dF(i, a, b, x) 的宏定义取消。考虑在将来把示例代码更换成更具代表性的代码。
  
• 2025/05/27 21:58 将本随笔置顶于个人博客主页，微调语言描述，增加第 \(\inf\) 部第二章「声明」。
  

来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！