From 6f754aa23d35246c3486fface957412bacbd2496 Mon Sep 17 00:00:00 2001 From: lzy Date: Fri, 17 May 2024 08:18:01 +0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=83=20docs:=20=E6=90=AD=E5=BB=BA?= =?UTF-8?q?=E7=8E=AF=E5=A2=83=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .clang-format | 324 ++++++++++++++++++++++++++++++++++++++++++++++++++ .gitignore | 1 + Makefile | 35 ++++++ README.md | 23 ++++ 4 files changed, 383 insertions(+) create mode 100755 .clang-format create mode 100644 Makefile diff --git a/.clang-format b/.clang-format new file mode 100755 index 0000000..61e94f9 --- /dev/null +++ b/.clang-format @@ -0,0 +1,324 @@ +# https://clang.llvm.org/docs/ClangFormatStyleOptions.html +# https://www.bbsmax.com/A/VGzlMjexJb/ + +# 语言: None, Cpp, Java, JavaScript, ObjC, Proto, TableGen, TextProto +Language: Cpp + +BasedOnStyle: LLVM + +# 访问说明符(public、private等)的偏移 +AccessModifierOffset: -4 + +# 左括号(左圆括号、左尖括号、左方括号)后的对齐: Align, DontAlign, AlwaysBreak(总是在左括号后换行) +AlignAfterOpenBracket: Align + +# 连续赋值时，对齐所有等号 +AlignConsecutiveAssignments: + Enabled: true + AcrossEmptyLines: false + AcrossComments: true + +# 连续声明时，对齐所有声明的变量名 +AlignConsecutiveDeclarations: + Enabled: true + AcrossEmptyLines: false + AcrossComments: true + +# 对齐连续位域字段的风格 +# AlignConsecutiveBitFields: AcrossEmptyLinesAndComments + +# 对齐连续宏定义的风格 +AlignConsecutiveMacros: + Enabled: true + AcrossEmptyLines: false + AcrossComments: true + +# 用于在使用反斜杠换行中对齐反斜杠的选项 +AlignEscapedNewlines: Left + +# 水平对齐二元和三元表达式的操作数 +AlignOperands: Align + +# 对齐连续的尾随的注释 +# 旧 +# AlignTrailingComments: true +# 新 +AlignTrailingComments: + Kind: Always + OverEmptyLines: 1 + +# 如果函数调用或带括号的初始化列表不适合全部在一行时 +# 允许将所有参数放到下一行，即使BinPackArguments为false +AllowAllArgumentsOnNextLine: false + +# 允许构造函数的初始化参数放在下一行 +AllowAllConstructorInitializersOnNextLine: false + +# 允许函数声明的所有参数在放在下一行 +AllowAllParametersOfDeclarationOnNextLine: false + + +# 允许短的块放在同一行(Always 总是将短块合并成一行，Empty 只合并空块) +AllowShortBlocksOnASingleLine: Empty + +# 允许短的case标签放在同一行 +AllowShortCaseLabelsOnASingleLine: true + +# 允许短的函数放在同一行: None, InlineOnly(定义在类中), Empty(空函数), Inline(定义在类中，空函数), All +AllowShortFunctionsOnASingleLine: Empty + +# 允许短的if语句保持在同一行 +AllowShortIfStatementsOnASingleLine: Never + +# 允许短的循环保持在同一行 +AllowShortLoopsOnASingleLine: false + +# 总是在定义返回类型后换行(deprecated) +AlwaysBreakAfterDefinitionReturnType: None + +# 总是在返回类型后换行: None, All, TopLevel(顶级函数，不包括在类中的函数), +# AllDefinitions(所有的定义，不包括声明), TopLevelDefinitions(所有的顶级函数的定义) + +# 函数声明返回类型后是否换行(None 自动，All全部，TopLevel...) +AlwaysBreakAfterReturnType: None + +# 总是在多行string字面量前换行 +AlwaysBreakBeforeMultilineStrings: false + +# 总是在template声明后换行 +AlwaysBreakTemplateDeclarations: false + +# false表示函数实参要么都在同一行，要么都各自一行 +BinPackArguments: false + +# false表示所有形参要么都在同一行，要么都各自一行 +BinPackParameters: false + +# 大括号换行，只有当 BreakBeforeBraces 设置为Custom时才有效 +BraceWrapping: + # case 语句后面 + AfterCaseLabel: true + # class定义后面 + AfterClass: true + # 控制语句后面 + AfterControlStatement: true + # enum定义后面 + AfterEnum: true + # 函数定义后面 + AfterFunction: true + # 命名空间定义后面 + AfterNamespace: false + # ObjC定义后面 + AfterObjCDeclaration: false + # struct定义后面 + AfterStruct: true + # union定义后面 + AfterUnion: true + # extern 导出块后面 + AfterExternBlock: false + # catch之前 + BeforeCatch: true + # else之前 + BeforeElse: true + # 缩进大括号(整个大括号框起来的部分都缩进) + IndentBraces: false + # 空函数的大括号是否可以在一行 + SplitEmptyFunction: false + # 空记录体(struct/class/union)的大括号是否可以在一行 + SplitEmptyRecord: false + # 空名字空间的大括号是否可以在一行 + SplitEmptyNamespace: false + +# 在二元运算符前换行: None(在操作符后换行), NonAssignment(在非赋值的操作符前换行), All(在操作符前换行) +BreakBeforeBinaryOperators: None + +# 在大括号前换行: Attach(始终将大括号附加到周围的上下文), Linux(除函数、命名空间和类定义，与Attach类似), +# Mozilla(除枚举、函数、记录定义，与Attach类似), Stroustrup(除函数定义、catch、else，与Attach类似), +# Allman(总是在大括号前换行), GNU(总是在大括号前换行，并对于控制语句的大括号增加额外的缩进), WebKit(在函数前换行), Custom +# 注：这里认为语句块也属于函数 + +# 大括号的换行规则 +BreakBeforeBraces: Custom + +# 三元运算操作符换行位置（?和: 在新行还是尾部） +BreakBeforeTernaryOperators: true + +# 在构造函数的初始化列表的逗号前换行 +BreakConstructorInitializersBeforeComma: false + +# 要使用的构造函数初始化式样式 +BreakConstructorInitializers: BeforeComma + +# 每行字符的限制，0表示没有限制 +ColumnLimit: 80 + +# 描述具有特殊意义的注释的正则表达式，它不应该被分割为多行或以其它方式改变 +# CommentPragmas: '' + +# 如果为true，则连续的名称空间声明将在同一行上。如果为false，则在新行上声明每个名称空间。 +CompactNamespaces: false + +# 构造函数的初始化列表要么都在同一行，要么都各自一行 +ConstructorInitializerAllOnOneLineOrOnePerLine: false + +# 构造函数的初始化列表的缩进宽度 +ConstructorInitializerIndentWidth: 4 + +# 延续的行的缩进宽度 +ContinuationIndentWidth: 4 + +# 去除C++11的列表初始化的大括号{后和}前的空格 +Cpp11BracedListStyle: true + +# 继承最常用的指针和引用的对齐方式 +DerivePointerAlignment: false + +# 关闭格式化 +DisableFormat: false + +# 自动检测函数的调用和定义是否被格式为每行一个参数(Experimental) +ExperimentalAutoDetectBinPacking: false + +# 如果为true，则clang格式会为短名称空间添加缺少的名称空间结尾注释，并修复无效的现有名称结束注释 +FixNamespaceComments: true + +# 需要被解读为foreach循环而不是函数调用的宏 +ForEachMacros: [ foreach, Q_FOREACH, BOOST_FOREACH ] + +# 对#include进行排序，匹配了某正则表达式的#include拥有对应的优先级，匹配不到的则默认优先级为INT_MAX(优先级越小排序越靠前)， +# 可以定义负数优先级从而保证某些#include永远在最前面 +IncludeCategories: + - Regex: '^"(llvm|llvm-c|clang|clang-c)/' + Priority: 2 + - Regex: '^(<|"(gtest|isl|json)/)' + Priority: 3 + - Regex: '.*' + Priority: 1 + +# 缩进case标签 +IndentCaseLabels: false + +# 要使用的预处理器指令缩进样式 +IndentPPDirectives: AfterHash + +# 缩进宽度 +IndentWidth: 4 + +# 函数返回类型换行时，缩进函数声明或函数定义的函数名 +IndentWrappedFunctionNames: false + +# 保留在块开始处的空行 +KeepEmptyLinesAtTheStartOfBlocks: true + +# 开始一个块的宏的正则表达式 +MacroBlockBegin: '' + +# 结束一个块的宏的正则表达式 +MacroBlockEnd: '' + +# 连续空行的最大数量 +MaxEmptyLinesToKeep: 5 + +# 命名空间的缩进: None, Inner(缩进嵌套的命名空间中的内容), All +# NamespaceIndentation: Inner + +# 使用ObjC块时缩进宽度 +ObjCBlockIndentWidth: 4 + +# 在ObjC的@property后添加一个空格 +ObjCSpaceAfterProperty: false + +# 在ObjC的protocol列表前添加一个空格 +ObjCSpaceBeforeProtocolList: true + +# 在call(后对函数调用换行的penalty +PenaltyBreakBeforeFirstCallParameter: 4 + +# 在一个注释中引入换行的penalty +PenaltyBreakComment: 300 + +# 第一次在<<前换行的penalty +PenaltyBreakFirstLessLess: 120 + +# 在一个字符串字面量中引入换行的penalty +PenaltyBreakString: 1000 + +# 对于每个在行字符数限制之外的字符的penalty +PenaltyExcessCharacter: 1000000 + +# 对每一个空格缩进字符的penalty(相对于前导的非空格列计算) +# PenaltyIndentedWhitespace: 0 + +# 将函数的返回类型放到它自己的行的penalty +PenaltyReturnTypeOnItsOwnLine: 120 + +# 指针和引用的对齐: Left, Right, Middle +PointerAlignment: Right + +# 允许重新排版注释 +ReflowComments: true + +# 允许排序#include +SortIncludes: true + +# 允许排序 using 声明顺序 +SortUsingDeclarations: false + +# 在C风格类型转换后添加空格 +SpaceAfterCStyleCast: false + +# 在逻辑非操作符(!)之后插入一个空格 +SpaceAfterLogicalNot: false + +# 在 template 关键字后插入一个空格 +SpaceAfterTemplateKeyword: false + +# 定义在什么情况下在指针限定符之前或之后放置空格 +# SpaceAroundPointerQualifiers: Before + +# 在赋值运算符之前添加空格 +SpaceBeforeAssignmentOperators: true + +# 左圆括号之前添加一个空格: Never, ControlStatements, Always +SpaceBeforeParens: ControlStatements + +# 空格将在基于范围的for循环冒号之前被删除 +SpaceBeforeRangeBasedForLoopColon: true + +# [ 前是否添加空格（数组名和[之间，Lambdas不会受到影响） +# 连续多个 [ 只考虑第一个（嵌套数组，多维数组） +SpaceBeforeSquareBrackets: false + +# 在空的圆括号中添加空格 +SpaceInEmptyParentheses: false + +# 在尾随的评论前添加的空格数(只适用于//) +SpacesBeforeTrailingComments: 3 + +# 在尖括号的<后和>前添加空格 +SpacesInAngles: false + +# 在容器(ObjC和JavaScript的数组和字典等)字面量中添加空格 +SpacesInContainerLiterals: false + +# 在C风格类型转换的括号中添加空格 +SpacesInCStyleCastParentheses: false + +# 如果为true，将在If/for/switch/while条件括号前后插入空格。 +SpacesInConditionalStatement: false + +# 在圆括号的(后和)前添加空格 +SpacesInParentheses: false + +# 在方括号的[后和]前添加空格，lamda表达式和未指明大小的数组的声明不受影响 +SpacesInSquareBrackets: false + +# 标准: Cpp03, Cpp11, Auto +Standard: Cpp11 + +# tab宽度 +TabWidth: 4 + +# 使用tab字符: Never, ForIndentation, ForContinuationAndIndentation, Always +UseTab: Never + diff --git a/.gitignore b/.gitignore index 298a66d..5e0176e 100644 --- a/.gitignore +++ b/.gitignore @@ -14,3 +14,4 @@ !**/makefile !**/Makefile !**/*.csv +!**/.clang-format diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..027145c --- /dev/null +++ b/Makefile @@ -0,0 +1,35 @@ +# 方便起见一般都会先定义编译器链接器 +CC = gcc +LD = gcc + +# 正则表达式表示目录下所有.c文件，相当于：SRCS = main.c a.c b.c +SRCS = $(wildcard *.c) + +# OBJS表示SRCS中把列表中的.c全部替换为.o，相当于：OBJS = main.o a.o b.o +OBJS = $(patsubst %c, %o, $(SRCS)) + +# 可执行文件的名字 +TARGET = main + +# .PHONE伪目标，具体含义百度一下一大堆介绍 +.PHONY:all clean + +# 要生成的目标文件 +all: $(TARGET) + +LDFLAGS=-L/usr/local/lib + +# LDLIBS=-lqueue -lllist + +# 第一行依赖关系：冒号后面为依赖的文件，相当于Hello: main.o a.o b.o +# 第二行规则：$@表示目标文件，$^表示所有依赖文件，$<表示第一个依赖文件 +$(TARGET): $(OBJS) + $(LD) $(LDFLAGS) -o $@ $^ $(LDLIBS) + +# 上一句目标文件依赖一大堆.o文件，这句表示所有.o都由相应名字的.c文件自动生成 +%.o:%.c + $(CC) -c $^ + +# make clean删除所有.o和目标文件 +clean: + rm -f $(OBJS) $(TARGET) diff --git a/README.md b/README.md index ff038d3..21ead6e 100644 --- a/README.md +++ b/README.md @@ -15,5 +15,28 @@ Linux环境C语言开发学习笔记 - C01 ~ C12 : Linux环境C语言基础 - C13 以后 : Linux环境系统编程 +## 环境搭建步骤 + +### 一、拥有一个linux系统 +- 虚拟机 +- WSL(Windows Subsystem for Linux) +- 云服务器 +- 双系统 + +### 二、安装编译环境 + +- 编译器：`gcc version 12.2.0 (Debian 12.2.0-14)` +- 代码提示：`clangd-vscode` +- 代码格式化：`clang-format` +- 调试工具：`gdb` +- 版本控制：`git` +- 编辑器：`vscode` +- AI补全：`Fitten Code` + +### 三、下载仓库 +- `fork`并且`clone`到本地（推荐） +- 直接下载压缩包到本地解压 + + ## 作者博客 [fugu的小站](https://lzyyyyyy.fun/index.php/tag/%E6%9D%8E%E6%85%A7%E8%8A%B9/)也会同步更新，欢迎造访以获得更好的在线`markdown`阅读体验。