#1、python格式化操作符
 
	符号         含义
    %c			格式化字符及其ASCII码
    %S			格式化字符串
    %d          格式化整数
    %o          格式化无符号八进制数
    %x          格式化无符号十六进制数
    %X          格式化无符号十六进制数（大写）
    %f          格式化浮点数字，可指定小数点后的精度
    %e          用科学计数法格式化浮点数
    %E          用科学计数法格式化浮点数
    %g          根据值的大小决定使用%f或%e
    %G          根据值的大小决定使用%f或%E
 
#2、格式化操作符的辅助指令
 符号 含义
 m.n m是显示的最小总宽度，n是小数点后的位数
 — 结果左对齐
 + 在正数前面显示加号(+)
 # 在八进制数前面显示’0o’，在十六进制数前面显示’0x64’或’0X64’
 0 显示的数字前面填充’0’代替空格
 
#3、python的转义字符及含义
 
符号                  说明
\'                  单引号
\"                  双引号
\a                  发出系统响铃声
\b                  退格符
\n                  换行符
\t                  横向制表符(TAB)
\v                  纵向制表符
\r                  回车键
\f                  换页符
\o                  八进制代表的字符
\x                  十六进制代表的字符
\0                  表示一个空字符
\\                  反斜杠         

 
 
复制别人的代码进行使用的时候，最烦的就是看到编辑器上显示的各种红色的、橙色的提示线吧？
 
尤其是那些不遵守PEP8规则的代码，等号两边的空格会加到你手软。
 
真希望哪天全世界写Python的小伙伴们都能统一代码规范啊！然而这显然是不可能的。
 
不过虽然无法改变他人，但我们可以改变自己。现在有了Black这个神器，我们可以在终端中输入一句命令自动使用最规范的代码风格来格式化代码！

对于初学者来说，用Black来学习代码规范也是一个非常不错的选择。
 
01.准备
 

开始之前，你要确保Python和pip已经成功安装在电脑上，如果没有，可以访问这篇文章：超详细Python安装指南 进行安装。

 
如果你用Python的目的是数据分析，可以直接安装Anaconda：Python数据分析与挖掘好帮手—Anaconda，它内置了Python和pip.
 
此外，推荐大家用VSCode编辑器，它有许多的优点：Python 编程的最好搭档—VSCode 详细指南。
 
请选择以下任一种方式输入命令安装依赖：
1. Windows 环境 打开 Cmd (开始-运行-CMD)。
2. MacOS 环境 打开 Terminal (command+空格输入Terminal)。
3. 如果你用的是 VSCode编辑器 或 Pycharm，可以直接使用界面下方的Terminal.
 
pip install black
 
02.使用
 
安装完成之后，你有两种使用black的方式，一种是直接在命令里输入：

 
black 你的文件路径.py
 
它就会自动格式化该Python文件，如果你使用VSCode，我推荐使用这种方法来格式化。
 
比如说下面这个糟糕的格式：
 

 
真的各种线条都出现了，安装完Black后你只需要在终端中输入：
 
black test.py
 

就能一键美化到符合PEP8标准的代码格式：

 

 
第二种是在Pycharm中一键使用。
 
在PyCharm菜单 File->Setting->Tools->External Tools->单击按钮“+”号：
 

 
为了能够一键执行命令，在弹出窗口里的Name中输入一个名字作为在以后在Pycharm 菜单->Tools->External Tools 中显示的名字。
 
这个名字将作为我们一键格式化代码的入口，我在此输入名字为BlackFormatter：
 

 
在Programs中输入black安装后的black.exe文件所在目录。该目录在Windows的cmd窗口中通过命令where black查找到，在Linux中用命令which black查找。
 

 
例如我的路径是：
C:\Users\Ckend\Anaconda3\Scripts\black.exe
将此包含balck.exe文件名的全路径填入到Programs框中。
 
最后在Arguments中填入$FilePath$，在Working Directory中填入$ProjectFileDir$。然后单击OK即可。
 


这样，只需要点击你刚配置时输入的名称：
 
Tools->External Tools -> BlackFormatter
 
即可直接格式化当前文件。


 


Pycharm下方如图所示则说明格式化成功：


 

 
Pycharm也可以使用命令的方式格式化，在Terminal里输入即可，因为它其实和Vscode的终端是一个东西，注意black安装的环境和你终端使用的虚拟环境是一致的就行。
 
我们的文章到此就结束啦，如果你喜欢今天的Python 实战教程，请持续关注Python实用宝典。
 
有任何问题，可以在公众号后台回复：加群，回答相应红字验证信息，进入互助群询问。
 
原创不易，希望你能在下面点个赞和在看支持我继续创作，谢谢！
 
点击下方阅读原文可获得更好的阅读体验
 
Python实用宝典 (pythondict.com)
不只是一个宝典
欢迎关注公众号：Python实用宝典
 
 

******阅读完此文，大概需要5分钟******
 
一、背景
 
代码风格人各有异，而且开发中复制粘贴的代码也很多，自己虽然常常开发后会敲一下快捷键control+i（Editor-Structure-Re-Indent），但是还是会忘记；
 
所以想着是不是可以有一套自动化工具，可以敲个脚本就把代码给格式化了（至少可以把缩进给解决了）;下面是我调研的几种思路和方案，它们主要是：
 
Control+i的命令化（不可行或者说没搞定）
利用Vim的格式化功能（可行，不是很推荐）
Clang-format的格式化代码功能（可行，推荐此种）
二、利用Vim的格式化功能
 
 
上面面这段是一段缩进比较乱的代码。
 
执行命令：
 
vim MDViewController.m
 
按ESC到命令模式，并输入 gg=G
 
或者：
 
按ESC到命令模块

gg 到全文开始

shift -v 可视化模式

G   到全文的末尾

=   格式化缩进全文
 
会有如下效果：
 
 
:wq保存， 就可以得到格式化后的代码；
 
 
但是有一个缺陷：
 
 
git中会有这个代码文件全量改动，也就是有些本来是不需要有改动的，也会一并给删除重新格式化了；这样会引起很多额外的排查工作，或者粗暴一点一并格式化了也行；
 
我们可以把这个过程脚本化，扫描工程的.h和.m文件，就可以实现工程的全量格式化扫描了。
 
三、Clang-format的格式化代码功能
 
关于它的详细介绍在这里（官网）以及github地址：
 
http://clang.llvm.org/docs/ClangFormat.html
 
https://github.com/rhysd/vim-clang-format
 
这是一个插件安装包，可以格式化C/C++/Java/JavaScript/Objective-C/Protobuf/C#等代码，功能强大。
 
1、安装：
 
https://www.jianshu.com/p/ba7aa6a2e4d1
 
或者
 
brew install clang-format
 
测试安装是否成功：
 
clang-format --help
 
可能出现的问题：
 
clang-format, bash 命令未找到。
 
需要修改bash_profile文件，添加运行路径。具体为vim ~/.bash_profile, 在文件内添加clang-format存放路径，保存后退出。 source ~/.bash_profile
 
2、使用
 
（1）生成配置文件 .clang-format，
 
//生成基于 LLVM 的配置文件
clang-format -style=LLVM -dump-config > .clang-format
 
配置文件打开如下：
 
---
# 语言: None, Cpp, Java, JavaScript, ObjC, Proto, TableGen, TextProto
Language:   Cpp
# BasedOnStyle: LLVM
# 访问说明符(public、private等)的偏移
AccessModifierOffset:   -4
# 开括号(开圆括号、开尖括号、开方括号)后的对齐: Align, DontAlign, AlwaysBreak(总是在开括号后换行)
AlignAfterOpenBracket:  Align
# 连续赋值时，对齐所有等号
AlignConsecutiveAssignments:    true
# 连续声明时，对齐所有声明的变量名
AlignConsecutiveDeclarations:   true
# 左对齐逃脱换行(使用反斜杠换行)的反斜杠
AlignEscapedNewlinesLeft:   true
# 水平对齐二元和三元表达式的操作数
AlignOperands:  true
# 对齐连续的尾随的注释
AlignTrailingComments:  true
# 允许函数声明的所有参数在放在下一行
AllowAllParametersOfDeclarationOnNextLine:  true
# 允许短的块放在同一行
AllowShortBlocksOnASingleLine:  false
# 允许短的case标签放在同一行
AllowShortCaseLabelsOnASingleLine:  false
# 允许短的函数放在同一行: None, InlineOnly(定义在类中), Empty(空函数), Inline(定义在类中，空函数), All
AllowShortFunctionsOnASingleLine:   Empty
# 允许短的if语句保持在同一行
AllowShortIfStatementsOnASingleLine:    false
# 允许短的循环保持在同一行
AllowShortLoopsOnASingleLine:   false
# 总是在定义返回类型后换行(deprecated)
AlwaysBreakAfterDefinitionReturnType:   None
# 总是在返回类型后换行: None, All, TopLevel(顶级函数，不包括在类中的函数),
#   AllDefinitions(所有的定义，不包括声明), TopLevelDefinitions(所有的顶级函数的定义)
AlwaysBreakAfterReturnType: None
# 总是在多行string字面量前换行
AlwaysBreakBeforeMultilineStrings:  false
# 总是在template声明后换行
AlwaysBreakTemplateDeclarations:    false
# false表示函数实参要么都在同一行，要么都各自一行
BinPackArguments:   true
# false表示所有形参要么都在同一行，要么都各自一行
BinPackParameters:  true
# 大括号换行，只有当BreakBeforeBraces设置为Custom时才有效
BraceWrapping:  
  # class定义后面
  AfterClass:   false
  # 控制语句后面
  AfterControlStatement:    false
  # enum定义后面
  AfterEnum:    false
  # 函数定义后面
  AfterFunction:    false
  # 命名空间定义后面
  AfterNamespace:   false
  # ObjC定义后面
  AfterObjCDeclaration: false
  # struct定义后面
  AfterStruct:  false
  # union定义后面
  AfterUnion:   false
  # catch之前
  BeforeCatch:  true
  # else之前
  BeforeElse:   true
  # 缩进大括号
  IndentBraces: false
# 在二元运算符前换行: None(在操作符后换行), NonAssignment(在非赋值的操作符前换行), All(在操作符前换行)
BreakBeforeBinaryOperators: NonAssignment
# 在大括号前换行: Attach(始终将大括号附加到周围的上下文), Linux(除函数、命名空间和类定义，与Attach类似),
#   Mozilla(除枚举、函数、记录定义，与Attach类似), Stroustrup(除函数定义、catch、else，与Attach类似),
#   Allman(总是在大括号前换行), GNU(总是在大括号前换行，并对于控制语句的大括号增加额外的缩进), WebKit(在函数前换行), Custom
#   注：这里认为语句块也属于函数
BreakBeforeBraces:  Custom
# 在三元运算符前换行
BreakBeforeTernaryOperators:    true
# 在构造函数的初始化列表的逗号前换行
BreakConstructorInitializersBeforeComma:    false
# 每行字符的限制，0表示没有限制
ColumnLimit:    200
# 描述具有特殊意义的注释的正则表达式，它不应该被分割为多行或以其它方式改变
CommentPragmas: '^ IWYU pragma:'
# 构造函数的初始化列表要么都在同一行，要么都各自一行
ConstructorInitializerAllOnOneLineOrOnePerLine: false
# 构造函数的初始化列表的缩进宽度
ConstructorInitializerIndentWidth:  4
# 延续的行的缩进宽度
ContinuationIndentWidth:    4
# 去除C++11的列表初始化的大括号{后和}前的空格
Cpp11BracedListStyle:   false
# 继承最常用的指针和引用的对齐方式
DerivePointerAlignment: false
# 关闭格式化
DisableFormat:  false
# 自动检测函数的调用和定义是否被格式为每行一个参数(Experimental)
ExperimentalAutoDetectBinPacking:   false
# 需要被解读为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
# 缩进宽度
IndentWidth:    4
# 函数返回类型换行时，缩进函数声明或函数定义的函数名
IndentWrappedFunctionNames: false
# 保留在块开始处的空行
KeepEmptyLinesAtTheStartOfBlocks:   true
# 开始一个块的宏的正则表达式
MacroBlockBegin:    ''
# 结束一个块的宏的正则表达式
MacroBlockEnd:  ''
# 连续空行的最大数量
MaxEmptyLinesToKeep:    1
# 命名空间的缩进: None, Inner(缩进嵌套的命名空间中的内容), All
NamespaceIndentation:   Inner
# 使用ObjC块时缩进宽度
ObjCBlockIndentWidth:   4
# 在ObjC的@property后添加一个空格
ObjCSpaceAfterProperty: false
# 在ObjC的protocol列表前添加一个空格
ObjCSpaceBeforeProtocolList:    true
# 在call(后对函数调用换行的penalty
PenaltyBreakBeforeFirstCallParameter:   19
# 在一个注释中引入换行的penalty
PenaltyBreakComment:    300
# 第一次在<<前换行的penalty
PenaltyBreakFirstLessLess:  120
# 在一个字符串字面量中引入换行的penalty
PenaltyBreakString: 1000
# 对于每个在行字符数限制之外的字符的penalty
PenaltyExcessCharacter: 1000000
# 将函数的返回类型放到它自己的行的penalty
PenaltyReturnTypeOnItsOwnLine:  60
# 指针和引用的对齐: Left, Right, Middle
PointerAlignment:   Left
# 允许重新排版注释
ReflowComments: true
# 允许排序#include
SortIncludes:   true
# 在C风格类型转换后添加空格
SpaceAfterCStyleCast:   false
# 在赋值运算符之前添加空格
SpaceBeforeAssignmentOperators: true
# 开圆括号之前添加一个空格: Never, ControlStatements, Always
SpaceBeforeParens:  ControlStatements
# 在空的圆括号中添加空格
SpaceInEmptyParentheses:    false
# 在尾随的评论前添加的空格数(只适用于//)
SpacesBeforeTrailingComments:   2
# 在尖括号的<后和>前添加空格
SpacesInAngles: true
# 在容器(ObjC和JavaScript的数组和字典等)字面量中添加空格
SpacesInContainerLiterals:  true
# 在C风格类型转换的括号中添加空格
SpacesInCStyleCastParentheses:  true
# 在圆括号的(后和)前添加空格
SpacesInParentheses:    true
# 在方括号的[后和]前添加空格，lamda表达式和未指明大小的数组的声明不受影响
SpacesInSquareBrackets: true
# 标准: Cpp03, Cpp11, Auto
Standard:   Cpp11
# tab宽度
TabWidth:   4
# 使用tab字符: Never, ForIndentation, ForContinuationAndIndentation, Always
UseTab: Never
...
 
编辑后我本地采用的配置文件：
 
Language:   ObjC
 
# 基础样式
 
BasedOnStyle: LLVM
 
# 缩进宽度
 
IndentWidth: 4
 
# 支持一行的if
 
AllowShortIfStatementsOnASingleLine: true
 
# switch的case缩进
 
IndentCaseLabels: false
 
# 针对OC的block的缩进宽度
 
ObjCBlockIndentWidth: 4
 
# 针对OC，属性名后加空格
 
ObjCSpaceAfterProperty: true
 
# 在ObjC的protocol列表前添加一个空格
 
ObjCSpaceBeforeProtocolList: true
 
# 每行字符的长度
 
ColumnLimit: 0
 
# 注释对齐
 
AlignTrailingComments: false
 
# 括号后加空格
 
SpaceAfterCStyleCast: false
 
# 不在小括号里加空格
 
SpacesInParentheses: false
 
# 不在中括号里加空格
 
SpacesInSquareBrackets: false
 
# 允许排序#include
SortIncludes:   false
 
# 换行的时候对齐操作符
AlignOperands: true
 
# 函数参数换行
AllowAllParametersOfDeclarationOnNextLine: true
# 允许短的块放在同一行
AllowShortBlocksOnASingleLine:  true
# 允许短的case标签放在同一行
AllowShortCaseLabelsOnASingleLine:  true
 
AllowShortIfStatementsOnASingleLine:    true
 
# 总是在多行string字面量前换行
AlwaysBreakBeforeMultilineStrings:  false
 
# false表示函数实参要么都在同一行，要么都各自一行
BinPackArguments:   true
# false表示所有形参要么都在同一行，要么都各自一行
BinPackParameters:  true
 
# 在三元运算符前换行
BreakBeforeTernaryOperators:    false
 
# 在构造函数的初始化列表的逗号前换行
BreakConstructorInitializersBeforeComma:    false
 
# 构造函数的初始化列表要么都在同一行，要么都各自一行
ConstructorInitializerAllOnOneLineOrOnePerLine: false
# 构造函数的初始化列表的缩进宽度
ConstructorInitializerIndentWidth:  0
# 延续的行的缩进宽度
ContinuationIndentWidth:    0
 
# 命名空间的缩进: None, Inner(缩进嵌套的命名空间中的内容), All
NamespaceIndentation:   All
 
（2）将其配置文件放入待修改文件平级或上级文件夹内，通过命令行来进行格式化
 
 
执行之后如下：
 
 
缺点：配置文件的规则太多了，需要慢慢调试；
 
（3）写脚本来批量执行：
 
以下是执行项目工程的结果：
 
 
这个改动量较大。
 
使用clang-format有以下几个注意点：
 
  1）排查一遍，reset掉一些不必要的改动，确保工程运行通过；
 
  2）clang-format 不同的机器执行结果可能会不一样；
 
  3）宏定义、block等特殊格式化可能会有点问题（经过多次调试尚未解决block的格式化问题，不过可以选择先reset掉block的相关代码）；
 
  4）可以集成到Xcode中，让自己编写的代码格式化；
 
4、批量处理自动化脚本（需要手动改路径）
 
如果想要源码，请关注以下公众号：
 
 
四、参考文档
 
clang-format：
 
Clang 12 documentation
 
Clang-Format在 Mac上的安装与使用
 
vim代码格式化插件clang-format
 
工具安装----Clang-format的基本使用
 
Objective-C代码风格及Clang-Format
 
Vim格式化：
 
vim之历史记录/代码缩进/代码自动补全
 
 

 
markdown格式化代码
 
There are two ways to format code in Markdown. You can either use inline code, by putting backticks (`) around parts of a line, or you can use a code block, which some renderers will apply syntax highlighting to.
 
 在Markdown中有两种格式化代码的方式。 您可以通过将反引号(`)放在行的各个部分周围来使用内联代码，也可以使用代码块，某些渲染器将对其应用语法突出显示。 
 
 
 内联代码 (Inline Code)
 
 
You can use inline code formatting to emphasize a small command or piece of syntax within a line you’re writing.
 
 您可以使用内联代码格式来强调您正在编写的一行中的一条小命令或一段语法。 
 
 
For example, you may wish to mention JavaScript’s Array.protoype.map() method. By using inline code formatting, it is clear that this is a piece of code. You might also use it to illustrate a terminal command, like yarn install.
 
 例如，您可能希望提及JavaScript的Array.protoype.map()方法。 通过使用内联代码格式，很明显这是一段代码。 您也可以使用它来说明终端命令，例如yarn install 。 
 
 
To use inline code formatting, simply wrap the code you wish to format in backticks. On a standard US layout QWERTY keyboard, this can be found to the left of ‘1’, and above the Tab key. More information on the location of the backtick on international keyboards is provided below.
 
 要使用内联代码格式，只需将要格式化的代码包装在反引号中即可。 在标准的美国布局QWERTY键盘上，可以在“ 1”的左侧和Tab键的上方找到它。 下面提供了有关国际键盘上反引号位置的更多信息。 
 
 
For instance, writing `Array.prototype.map()` in markdown will render as Array.prototype.map().
 
 例如，在markdown中写入Array.prototype.map()将呈现为Array.prototype.map() 。 
 
 
 代码块 (Code Blocks)
 
 
To write longer or more detailed snippets of code, it is often better to place them inside a code block. Code blocks allow you to use multiple lines, and markdown will render it inside its own box and with code type font.
 
 要编写更长或更详细的代码片段，通常最好将它们放在代码块中。 代码块允许您使用多行，并且markdown会将其呈现在其自己的框内，并使用代码类型的字体。 
 
 
To achieve this, start your block with a line of three backticks. This signals to markdown that you are creating a code block. You will need to finish with another line of three backticks. For example:
 
 为此，请以三个反引号开始行。 这向标记降价表示您正在创建代码块。 您将需要完成另外三个反引号行。 例如： 
 
 
```var add2 = function(number) {   return number + 2;}```
 
 ``var add2 = function(number){返回数字+ 2;}`'' 
 
 
will render in markdown as:
 
 将在markdown中呈现为： 
 
 
var add2 = function(number) {
  return number + 2;
}
 
 语法高亮 (Syntax highlighting)
 
 
While not supported natively by markdown, many markdown engines, including the one used by GitHub, will support syntax highlighting. This means that by telling markdown what language you're using inside the code block, it will add colors like an IDE would.
 
 虽然markdown本身不支持Markdown引擎，但许多markdown引擎(包括GitHub所使用的引擎)将支持语法突出显示。 这意味着通过告诉markdown您在代码块内使用的是哪种语言，它将像IDE一样添加颜色。 
 
 
You can do this by adding the name of the language on the same line as your opening three back ticks. In the example above, if instead of the first line being ``` you could write ```js, then JavaScript highlighting will be applied to the block.
 
 为此，您可以在打开三个倒钩的同时，在同一行添加语言名称。 在上面的示例中，如果您可以编写```js而不是第一行，那么JavaScript高亮将应用于该块。 
 
 
var add2 = function(number) {
	return number + 2;
}
 
Syntax highlighting can be applied to more than just JavaScript, though. You can use ```html:
 
 但是，语法高亮不仅仅可以应用于JavaScript。 您可以使用```html： 
 
 
<div class="row">
  <div class="col-md-6 col-md-offset-3">
    <h1>Hello World</h1>
  </div>
</div>
 
```ruby:
 
 Ruby： 
 
 
"Hello World".split('').each do |letter|
  puts letter
end
 
or ```python:
 
 或```python： 
 
 
a, b = 0, 1
while b < 10:
    print(b)
    a, b = a, a + b
 
Just remember, not all markdown engines will apply syntax highlighting.
 
 请记住，并非所有降价引擎都会应用语法突出显示。 
 
 
 国际键盘上的反引号 (Backticks on international keyboards)
 
 
The location of the backtick key can be different on different keyboards, and if you’re not using a US layout QWERTY keyboard, it may be tricky to find. This helpful guide lists some of the ways to find your backtick key, which we’ve collected here below:
 
 在不同的键盘上，反引号键的位置可能会有所不同，如果您使用的不是美国布局的QWERTY键盘，可能很难找到。 该实用指南列出了一些查找反引号的方法，我们在下面收集了这些信息： 
 
 
 QWERTY和QWERTZ： (QWERTY and QWERTZ:)
 
 
 AZERTY： (AZERTY:)
 
 

  
翻译自: https://www.freecodecamp.org/news/how-to-format-code-in-markdown/
 
 
markdown格式化代码